Update a Wholesale Customer
This API allows a Service Provider to update certain details of a provisioned Wholesale customer.
The Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.
packages Note:
cisco_calling_planis dependent on:common_area_calling,webex_calling,webex_suite,webex_voice,cx_essentialsattendant_consoleis dependent on:webex_calling,webex_suite,cx_essentials
After successful invocation of this endpoint a URL will be returned in the Location header, which will point to the Get a Wholesale Customer endpoint for this customer.
URI Parameters
A unique identifier for the customer to be updated.
Query Parameters
The encoded organization ID for the sub partner.
Body Parameters
External ID of the Wholesale customer.
The complete list of Webex Wholesale packages to be assigned to the customer, including any packages already provisioned. If a package has already been assigned to this customer and is not present in this list, then that package will be removed.
Billing Address of the customer.
AddressLine1.
AddressLine2.
City of the customer.
State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.
Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.
ISO2 country code of the customer size = 2.
Provisioning parameters are required when updating an existing package.
Name of the wholesale customer office.
Address of the wholesale customer.
State or Province of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.
Postal/Zip code of the customer. This attribute may be required in specific geographies, please refer to address section in the admin guide for more information.
Customer timezone for calling package. The full list of supported timezones can be found at List of Time Zones for Wholesale Provisioning.
Determine language for all generated emails and voice announcements.
SIP Header for any emergency calls from this location.
Customer timezone for meetings package.
The email of the sub partner organization admin.
Response Properties
A URL which points to the Get a Wholesale Customer endpoint for the provisioned customer.
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
- External ID of the Wholesale customer.
- The complete list of Webex Wholesale packages to be assigned to the customer, including any packages already provisioned. If a package has already been assigned to this customer and is not present in this list, then that package will be removed.
- Billing Address of the customer.
- Provisioning parameters are required when updating an existing package.
- The email of the sub partner organization admin.
{
"externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
"packages": [
"common_area_calling",
"webex_calling",
"webex_meetings",
"webex_suite",
"webex_voice",
"cx_essentials",
"cisco_calling_plan",
"attendant_console"
],
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"provisioningParameters": {
"calling": {
"location": {
"name": "Head Office",
"address": {
"addressLine1": "771 Alder Drive",
"addressLine2": "Cisco Site 5",
"city": "Milpitas",
"stateOrProvince": "CA",
"zipOrPostalCode": "95035",
"country": "US"
},
"timezone": "America/Los_Angeles",
"language": "en_us",
"emergencyLocationIdentifier": "95547321"
}
},
"meetings": {
"timezone": "America/Los_Angeles"
}
},
"subPartnerAdminEmail": "admin@subpartnerorg.com"
}{
"url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4"
}