DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Platform IntroductionBotsButtons and CardsIntegrationsWidgetsGuest IssuerDeveloper SandboxPromote your AppFAQs
Embedded Apps
OverviewDeveloper GuideDesign Guidelines for MeetingsDesign Guidelines for MessagingAPI ReferenceSubmission Checklist for Embedded Apps
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Webex for BroadWorksIntegrations and AuthorizationWebex for Wholesale
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks Subscribers
GETList BroadWorks Subscribers
POSTProvision a BroadWorks Subscriber
GETGet a BroadWorks Subscriber
PUTUpdate a BroadWorks Subscriber
DELETERemove a BroadWorks Subscriber
Call ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale Billing ReportsWholesale CustomersWholesale Subscribers
Devices
Overview
Guides
Workspace Integrations Guide
Reference
Device ConfigurationsDevicesPlacesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Meeting Resource GuideEmbedded Apps GuideEmbedded Apps ReferenceIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksWebinar Guide
Reference
Meeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsPeopleRecording ReportRecordingsWebhooks
Messaging
Overview
Guides
Embedded Apps GuideEmbedded Apps ReferenceBotsIntegrations and AuthorizationEmbedded Apps Design and Experience GuidelinesWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsWebhooks
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks Subscribers
GETList BroadWorks Subscribers
POSTProvision a BroadWorks Subscriber
GETGet a BroadWorks Subscriber
PUTUpdate a BroadWorks Subscriber
DELETERemove a BroadWorks Subscriber
Call ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale Billing ReportsWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJavaCommunity
Developer CommunityCertifications

Update a BroadWorks Subscriber

This API will allow a Service Provider to update certain details of a provisioned BroadWorks subscriber on Cisco Webex.

The updated items will not be immediately reflected in the response body, but can be subsequently obtained via the Get a BroadWorks Subscriber API once the status has transitioned from the updating state to the provisioned state.

PUT/v1/broadworks/subscribers/{subscriberId}
URI Parameters
subscriberId
stringrequired

A unique identifier for the subscriber in question.

Body Parameters
userId
string

The user ID of the subscriber on BroadWorks.

firstName
string

The first name of the subscriber.

lastName
string

The last name of the subscriber.

primaryPhoneNumber
string

The primary phone number configured against the subscriber on BroadWorks.

mobilePhoneNumber
string

The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.

language
string

The ISO 639-1 language code associated with the subscriber. Reserved for future use - any value currently specified will be ignored during subscriber provisioning.

timezone
string

The time zone associated with the subscriber. Refer to the Webex Meetings Site Timezone section of the Webex for BroadWorks guide for more information.

package
string

The Webex for BroadWorks Package to be assigned to the subscriber.

Response Properties
id
string

A unique Cisco identifier for the subscriber.

personId
string

The Person Id of the subscriber on Cisco Webex. To be used when referencing this subscriber on other Cisco Webex APIs. Only presented when status is provisioned.

userId
string

The user ID of the subscriber on BroadWorks.

spEnterpriseId
string

The Service Provider supplied unique identifier for the subscriber's enterprise.

firstName
string

The first name of the subscriber.

lastName
string

The last name of the subscriber.

email
string

The email address of the subscriber.

primaryPhoneNumber
string

The primary phone number configured against the subscriber on BroadWorks.

mobilePhoneNumber
string

The mobile phone number configured against the subscriber on BroadWorks.

language
string

The ISO 639-1 language code associated with the subscriber. Reserved for future use - any value returned should be ignored. Currently fixed to "en" in all responses.

package
enum

The Webex for BroadWorks Package assigned to the subscriber.

softphone
string

Softphone package

basic
string

Basic package

standard
string

Standard package

premium
string

Premium package

status
enum

The provisioning status of the user.

pending_email_input
string

Subscriber Provisioning is paused, pending input of email address.

pending_email_validation
string

Subscriber Provisioning is paused. The subscriber has entered an email address but has yet to complete validation.

pending_user_migration
string

Subscriber Provisioning is paused. An automated email is sent to the subscriber, waiting for the subscriber's consent.

provisioning
string

Subscriber provisioning is in progress.

provisioned
string

The subscriber is fully provisioned on Cisco Webex.

updating
string

An update is in progress for a provisioned subscriber.

error
string

An error occurred provisioning the subscriber on Cisco Webex.

errors
array[Error]

List of errors that occurred during that last attempt to provision/update this subscriber.

Note:

  • This list captures errors that occurred during asynchronous or background provisioning of the subscriber, after the API has been accepted and 200 OK response returned.

  • Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode
number

An error code that identifies the reason for the error

description
string

A textual representation of the error code.

created
string

The date and time the subscriber was provisioned.

lastStatusChange
string

The date and time the provisioning status of the subscriber last changed.

provisioningId
string

This Provisioning ID associated with this subscriber.

selfActivated
boolean

Indicates if the subscriber was self activated, rather than provisioned via these APIs.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
PUT
/v1/broadworks/subscribers/
Log in to try the API.
Header
Body
  • The user ID of the subscriber on BroadWorks.
  • The first name of the subscriber.
  • The last name of the subscriber.
  • The primary phone number configured against the subscriber on BroadWorks.
  • The mobile phone number configured against the subscriber on BroadWorks. Any empty value on update will remove the already configured mobile phone number.
  • The ISO 639-1 language code associated with the subscriber. Reserved for future use - any value currently specified will be ignored during subscriber provisioning.
  • The time zone associated with the subscriber. Refer to the [Webex Meetings Site Timezone](https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) section of the [Webex for BroadWorks](https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide) guide for more information.
  • The Webex for BroadWorks Package to be assigned to the subscriber.
  • Request
  • Response
https://webexapis.com/v1/broadworks/subscribers/Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk
{
  "userId": "95547321@sp.com",
  "firstName": "John",
  "lastName": "Andersen",
  "primaryPhoneNumber": "+1-240-555-1212",
  "mobilePhoneNumber": "+1-818-279-1234",
  "language": "en",
  "timezone": "America/Los_Angeles",
  "package": "premium"
}
200 / OK
{
    "id": "Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk",
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
    "userId": "95547321@sp.com",
    "spEnterpriseId": "Reseller1+acme",
    "firstName": "John",
    "lastName": "Andersen",
    "email": "john.anderson@acme.com",
    "primaryPhoneNumber": "+1-240-555-1212",
    "mobilePhoneNumber": "+1-818-279-1234",
    "language": "en",
    "package": "premium",
    "status": "updating",
    "created": "2019-10-18T14:26:16.000Z",
    "lastStatusChange": "2020-03-18T16:05:34.000Z",
    "provisioningId": "ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ",
    "selfActivated": "false"
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2022 Cisco and/or its affiliates. All rights reserved.