Update a Wholesale Subscriber
This API allows a Service Provider to update certain details of a provisioned Wholesale subscriber.
Note:
The
provisioningParametersattributes should only be supplied when changing from the webex_meetings package to any calling-enabled package.Even in that scenario, if this subscriber is an existing Webex Calling entitled user, these attributes are optional and if provided are ignored.
packages Note:
attendant_consoleis dependent on:webex_calling,webex_suite,cx_essentials
Either packages or package field is required but not both.
URI Parameters
A unique identifier for the subscriber in question.
Query Parameters
The encoded organization ID for the sub partner.
Body Parameters
The Webex Wholesale package to be assigned to the subscriber. NOTE: This parameter will be deprecated soon. Please
use packages instead.
Calling Basic Package.
Meetings Package.
Suite Package.
Voice Package.
Customer Experience Essentials Package.
The complete list of Webex Wholesale packages assigned to the subscriber. Currently accepts only one package in the list.
The primary phone number configured for the subscriber. A primary phone number, extension, or both must be supplied when changing from the webex_meetings package to any calling-enabled package.
The extension configured for the subscriber. An extension, primary phone number or both must be supplied when changing from the webex_meetings package to any calling-enabled package.
A unique identifier for the location. This id should be retrieved via the List Locations API.
Response Properties
A unique Cisco identifier for the subscriber.
The person id of the subscriber used in the /people API. Only presented when status is provisioned.
The email address of the subscriber.
A unique identifier for the customer.
External ID of the Wholesale customer.
The Webex Wholesale Package assigned to the subscriber.
Calling Basic Package.
Meetings Package.
Suite Package.
Voice Package.
Customer Experience Essentials Package.
The list of Webex Wholesale packages assigned to the subscriber.
The provisioning status of the user.
The subscriber is fully provisioned on Cisco Webex.
The subscriber user migration is pending.
List of errors that occurred during that last attempt to provision/update this subscriber.
Note:
This list captures errors that occurred during provisioning of the subscriber.
Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.
An error code that identifies the reason for the error.
A textual representation of the error code.
The date and time the subscriber was provisioned.
The date and time the provisioning status of the subscriber last changed.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- The encoded organization ID for the sub partner.
Body
- The Webex Wholesale package to be assigned to the subscriber. **NOTE:** This parameter will be deprecated soon. Please use `packages` instead.
- The complete list of Webex Wholesale packages assigned to the subscriber. Currently accepts only one package in the list.
{
"packages": [
"webex_calling"
],
"provisioningParameters": {
"primaryPhoneNumber": "+1-240-555-1212",
"extension": "5221",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAxMjM0NTY3LTg5YWItY2RlZi0wMTIzLTQ1Njc4OWFiY2RlZg=="
}
}
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"email": "johnandersen@acme.com",
"customerId": "Y2lzY29zcGFyazovL3VzL0NVU1RPTUVSL2Y1YjM2MTg3LWM4ZGQtNDcyNy04YjJmLWY5YzQ0N2YyOTA0Ng",
"externalCustomerId" : "c1677a16-557a-4fb4-b48f-24adde57ec99",
"package": "webex_calling",
"status": "provisioned",
"lastStatusChange": "2021-08-06T02:05:41.791232Z",
"created": "2021-08-06T02:03:00.062Z",
"packages": ["webex_calling"]
}