The Webex Wholesale Provisioning API is for the Service Providers (SPs) who sign up for Cisco Webex Wholesale. The API enables those SPs to provision, update, and remove wholesale customer/subscribers. For more information about Webex Wholesale, please see the [Webex Wholesale Route-to-Market Solution Guide](https://help.webex.com/en-us/article/nkguodc/Wholesale-Route-to-Market-Solution-Guide). ### Provisioning Precheck APIs The Webex Wholesale Provisioning Precheck APIs are for Partner Sales team to determine the likely success of a customer or subscriber provisioning. The info codes used by the Provisioning Precheck APIs are defined in the [Provisioning Precheck API Info Codes](/docs/api/guides/webex-for-wholesale#provisioning-precheck-api-info-codes) section. For more information, see [Using the Provisioning Precheck API](/docs/api/guides/webex-for-wholesale#using-the-provisioning-precheck-api). - [Precheck a Wholesale Customer Provisioning](/docs/api/v1/wholesale-provisioning/precheck-a-wholesale-customer-provisioning) - [Precheck a Wholesale Subscriber Provisioning](/docs/api/v1/wholesale-provisioning/precheck-a-wholesale-subscriber-provisioning) ### Provisioning APIs The Webex Wholesale Provisioning API is for the Service Providers (SPs) who sign up for Cisco Webex Wholesale. The API enables those SPs to provision, update, and remove wholesale customer/subscribers. Error codes used by the Provisioning API are defined in the [API Error Codes](/docs/api/guides/webex-for-wholesale#api-error-codes) section. Wholesale Customer Provisioning APIs - [View Wholesale Customers](/docs/api/v1/wholesale-provisioning/list-wholesale-customers) - [Provision a Wholesale Customer](/docs/api/v1/wholesale-provisioning/provision-a-wholesale-customer) - [View a Wholesale Customer](/docs/api/v1/wholesale-provisioning/get-a-wholesale-customer) - [Update a Wholesale Customer](/docs/api/v1/wholesale-provisioning/update-a-wholesale-customer) - [Delete a Wholesale Customer](/docs/api/v1/wholesale-provisioning/remove-a-wholesale-customer) Wholesale Subscriber Provisioning APIs - [View Wholesale Subscribers](/docs/api/v1/wholesale-provisioning/list-wholesale-subscribers) - [Provision a Wholesale Subscriber](/docs/api/v1/wholesale-provisioning/provision-a-wholesale-subscriber) - [View a Wholesale Subscriber](/docs/api/v1/wholesale-provisioning/get-a-wholesale-subscriber) - [Update a Wholesale Subscriber](/docs/api/v1/wholesale-provisioning/update-a-wholesale-subscriber) - [Delete a Wholesale Subscriber](/docs/api/v1/wholesale-provisioning/remove-a-wholesale-subscriber) ### Billing Reports APIs The Wholesale Billing Reports Public APIs are a set of APIs that are targeted at Service Providers who sign up to the Webex Wholesale solution. These APIs provides partner, customer and user breakdown reports to the Service Providers or Partners. Service Providers can use these reports to reconcile their monthly invoice. If partner has sub-partner relationships created, then partner can use an additional parameter `subPartnerOrgId` in [Create a Wholesale Billing Report](/docs/api/v1/wholesale-billing/create-a-wholesale-billing-report) to generate individual sub-partner reports to reconcile their monthly invoice. - [List Wholesale Billing Reports](/docs/api/v1/wholesale-billing/list-wholesale-billing-reports) - [Create a Wholesale Billing Report](/docs/api/v1/wholesale-billing/create-a-wholesale-billing-report) - [Get a Wholesale Billing Report](/docs/api/v1/wholesale-billing/get-a-wholesale-billing-report) - [Delete a Wholesale Billing Report](/docs/api/v1/wholesale-billing/delete-a-wholesale-billing-report) ## API Backward Compatibility The APIs defined in this guide change over time as functionality is added, deprecated, or changed. The strategy defined below is followed for any changes, to minimize disruption to users and applications that implement the API. - Any significant change to an API is announced in the [API Changelog](/docs/api/changelog). This applies for breaking changes as well as new functionality and backward compatible changes. - New API endpoints, new query parameters on existing endpoints, new optional fields in request bodies, and new data in response bodies should not affect the compatibility of the API with existing calls to the API. Applications that use the API should be robust to these improvements. - When the API needs to change outside of the scope described above, a Breaking Change will be announced in the API Changelog, with details of the change and an expected implementation date. ## Authentication When registering your application as an [Integration](/docs/integrations), enable the following scopes to access all Webex Wholesale APIs:

If a Refresh Token expires, then the application can no longer generate the necessary access tokens for this API. A Service Provider admin needs to reauthorize the application to gain access to the APIs again. Therefore, it's important that your application maintain an active Refresh Token. Generating a new access token automatically renews the lifetime of your Refresh Token. An application that is regularly generating new access tokens will also be renewing its Refresh Token lifetime. However, if the application becomes inactive for a long period of time (Refresh token expiry is 90 days) then it runs the risk of allowing the Refresh Token to expire. Therefore, it is recommended that your application run a scheduled task or job that generates a new access token using the Refresh Token. This ensures the Refresh Token will not expire, even during periods of inactivity.

## Asynchronous Provisioning Model Wholesale organization provisioning on Cisco Webex can take considerable time. Therefore, the Webex Wholesale organization provisioning APIs don’t wait or block until organization is fully provisioned. Instead, the API responds quickly while initiating organization provisioning as a background task. You can design your application to query the wholesale organization later to determine its provisioning status. All representations of the organization through the APIs include a “status” attribute to indicate the organization’s provisioning status: On successful completion, the organization status changes to “provisioned”. If any error occurs during provisioning, the organization status transitions to “error”. The organization representation through these APIs also includes specific error codes and the reasons behind the provisioning error. ## Using the Provisioning Precheck API The Webex Wholesale Provisioning Precheck APIs are for Partner Sales team to determine the likely success of a customer or subscriber provisioning who sign up for Cisco Webex Wholesale. The Precheck APIs supports two variants of Wholesale Customer Provisioning Precheck Requests and three variants of Wholesale Subscriber Provisioning Precheck Requests. ### Wholesale Customer Provisioning Precheck API Sample partial provisioning request with `customerInfo.primaryEmail` and `address` parameters: ```json { "customerInfo" : { "primaryEmail" : "john.anderson@acme.com" }, "address": { "addressLine1": "771 Alder Drive", "addressLine2": "Cisco Site 5", "city": "Milpitas", "stateOrProvince": "CA", "zipOrPostalCode": "95035", "country": "US" } } ``` Sample full provisioning request with `provisioningId`, `packages`, `orgId`, `externalId`, `address`, `customerInfo` and `provisioningParameters` parameters: ```json { "provisioningId": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4", "packages": [ "common_area_calling", "webex_calling", "webex_meetings", "webex_suite" ], "orgId": "Y2lzY29zcGFyazovL3VzL09SRtR", "externalId": "c1677a16-557a-…", "address": { "addressLine1": "771 Alder Drive", "addressLine2": "Cisco Site 5", "city": "Milpitas", "stateOrProvince": "CA", "zipOrPostalCode": "95035", "country": "US" }, "customerInfo": { "name": "John's Pizza", "primaryEmail": "john.anderson@acme.com" }, "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" } } } ``` ### Wholesale Subscriber Provisioning Precheck API Sample partial provisioning request with `customerInfo.primaryEmail` and `email` parameters: ```json { "customerInfo" : { "primaryEmail" : "john.anderson@acme.com" }, "email": "alice.anderson@acme.com" } ``` Sample partial provisioning request with `customerId` and `email` parameters: ```json { "customerId": "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR" "email": "alice.anderson@acme.com" } ``` Sample full provisioning request with `customerId`, `provisioningId`, `email`, `package`, `provisioningParameters` parameters: ```json { "customerId" : "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR", “provisioningId” : “Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4”, “email” : “john.anderson@acme.com”, "package" : "webex_suite", “provisioningParameters” : { "firstName" : "John", "lastName" : "Anderson", "primaryPhoneNumber" : "+ 1-240-555-1212", "extension" : "51212", "locationId" : "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtIyMmMtNDY3YzUxNTkxOTA4" } } ``` Sample full provisioning request with `customerId`, `provisioningId`, `email`, `packages`, `provisioningParameters` parameters: ```json { "customerId" : "Y2lzY29zcGFyazovL3VzL09vL3VzL0VOVEVSUFJJU0UvNTJSRtR", “provisioningId” : “Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4”, “email” : “john.anderson@acme.com”, "packages" : [ "webex_suite", ], “provisioningParameters” : { "firstName" : "John", "lastName" : "Anderson", "primaryPhoneNumber" : "+ 1-240-555-1212", "extension" : "51212", "locationId" : "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtIyMmMtNDY3YzUxNTkxOTA4" } } ``` ## Wholesale Customer Identities Wholesale Customers are referenced by different identities across the Webex platform. This section describes these identities and how integrations should transition between each identity depending on what Webex API you are integrating with. ### Common Identity Organization ID This is the identifier for the Customer on core internal services such as Common Identity. This is a Universal Unique Identifier (UUID). It is leveraged primarily by Identity specific APIs. ### Webex Organization ID This is the public identifier for all Webex Customer Organizations. It is used across the majority of Webex APIs. It is a base64Url encoding of the following string: `ciscospark://us/ORGANIZATION/{IdentityOrgUUID}` where `IdentityOrgUUID` represents the Common Identity Organization ID. A sample string to be encoded would look as follows: `ciscospark//us/ORGANIZATION/03b4d559-9bfd-4066-a692-d1faefd0c599`. ### Wholesale Customer ID Wholesale Customers can exist and be referenced via Wholesale APIs prior to full provisioning on the Webex Platform. As such a distinct identifier is needed to represent such customers. The Wholesale Customer ID represents that distinct identifier. Once the customer is fully provisioned, their associated Webex Organization ID is returned in response to any Wholesale Customer API. ### Transition between Wholesale Customer ID and Webex Organization ID Wholesale Customer API payload includes both the Wholesale Customer ID and the Webex Organization ID. See sample response from `GET /wholesale/customers/{id}` below, with Wholesale Customer ID `id` and Webex Organization ID `orgId`. ```json { "id": "Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4", "orgId": "Y2lzY29zcGFyay8vdXMvT1JHQU5JWkFUSU9OLzAzYjRkNTU5LTliZmQtNDA2Ni1hNjkyLWQxZmFlZmQwYzU5OQ==", "externalId": "c100012", "address" :{ "addressLine1": "771 Alder Drive", "addressLine2": "Cisco Site 5", "city": "Milpitas", "stateOrProvince": "CA", "zipOrPostalCode": "95035", "country": "US" }, "status": "provisioned", "packages": [ "webex_calling" ], "resourceDetails": { "packages": [{ "name": "webex_calling", "status": "provisioned" }] } } ``` The `orgId` attribute is included as soon as the customer has been provisioned on the Webex platform. As required, this attribute can be used directly as customer org identifier to for the majority of other Webex APIs. Additionally, the Wholesale Customer List/Search API allows searching by orgId: `GET /wholesale/customers?orgId=xxxxx`. This allows developers to discover the associated Wholesale Customer and transition back to Wholesale Customer ID as needed. ### Transition between Webex Organization ID and Common Identity Organization ID The Webex Organization ID is a base64-encoded string that includes the underlying Common Identity Organization ID. It is straightforward to transition between either format as required. Below are high level steps needed to perform the transitions. Retrieve the Common Identity Organization ID from the Webex Organization ID: 1. Base64Url decode the Webex Organization ID. The decoded string will be formatted as follows: `ciscospark://us/ORGANIZATION/{IdentityOrgUUID}`. 2. Remove the `ciscospark://us/ORGANIZATION/` prefix from the decoded string to leave the Common Identity Org UUID. Generate a Webex Organization ID from Common Identity Organization ID: 1. Concatenate the `ciscospark://us/ORGANIZATION/` prefix plus the Common Identity Organization ID into a single string: `ciscospark//us/ORGANIZATION/{IdentityOrgUUID}`. 2. Base64Url encode this string to generate the Webex Organization ID. For example: - Common Identity Organization ID: `03b4d559-9bfd-4066-a692-d1faefd0c599`. - Concatenated String: `ciscospark://us/ORGANIZATION/03b4d559-9bfd-4066-a692-d1faefd0c599`. - Base64Url Encoded Webex Organization ID: `Y2lzY29zcGFyay8vdXMvT1JHQU5JWkFUSU9OLzAzYjRkNTU5LTliZmQtNDA2Ni1hNjkyLWQxZmFlZmQwYzU5OQ==`. ## Managing your customer organizations Once your Wholesale customer has been provisioned, you may then use the broader set of administrative APIs documented on this portal to manage services for your customer.

To support customer management, your application must be authorized by a user with **Partner full administrator role**, since such users are entitled to manage all customers under your Partner organization. In order to manage service for a specific customer, you must first request management access by calling the [GET Organizations Details API](/docs/api/v1/organizations/get-organization-details). This will grant you temporary access to the customer organization. You may then proceed to manage the customer via the desired API. If you find any attempt to manage your customer via API set returns a 403 Forbidden response, it may be that your temporary access to the customer has expired. In such cases, call the [GET Organizations Details API](/docs/api/v1/organizations/get-organization-details) again to re-establish the desired access before proceeding with your management operation. Note: You can expect a short delay (5 seconds) after the above request before management access to the customer organization is fully established. ## Implementation Notes ### Wholesale Customer Address Requirement The billing address and calling address of the customer should be provided per the below guidelines: | Attribute | Mandatory | |-----------------|------------------------------------------| | `addressLine1` | Yes | | `addressLine2` | No | | `city` | Yes | | `stateOrProvince` | Mandatory for some geographic locations. | | `zipOrPostalCode` | Mandatory for some geographic locations. | | `country` | Yes | ### Subscriber Deletion Webex Wholesale APIs supports both a soft and hard deletion model for subscribers. - **Soft Delete:** The Webex Wholesale [Delete a Wholesale Subscriber](/docs/api/v1/wholesale-provisioning/remove-a-wholesale-subscriber) removes all entitlements and capabilities from when the subscriber was first provisioned for Webex Wholesale. But, the subscriber remains provisioned within their Customer organization on Cisco Webex. The subscriber may continue to use Webex in line with their remaining capabilities. - **Hard Delete:** If you wish to remove the subscriber completely from Cisco Webex, perform a DELETE with the [People APIs](/docs/api/v1/people). ### Organization Deletion Follow the instructions below in order to delete an organization. 1. Delete all subscribers from the organization using the [Delete a Person](/docs/api/v1/people/delete-a-person) API. The removal of users may take some time depending on quantity of users. 1. Delete all workspace from the organization. 1. **Soft Delete**—The Webex Wholesale [Delete a wholesale customer](/docs/api/v1/wholesale-provisioning/remove-a-wholesale-customer) removes entitlements and Webex calling capabilities from the organization from when the customer was first provisioned for Webex Wholesale. But, the customer remains provisioned within their Partner organization on Cisco Webex. 1. **Hard Delete**—If you wish to remove the Organization completely from Cisco Webex, perform a DELETE with the [Delete Organization](/docs/api/v1/organizations/delete-organization). 1. Using [Delete a wholesale customer](/docs/api/v1/wholesale-provisioning/remove-a-wholesale-customer) API. 1. The organization now can be deleted using the [Delete Organization](/docs/api/v1/organizations/delete-organization) API. ## Webex Meetings Site Timezone If a specific Webex Meetings site timezone is required, please specify the meeting timezone parameter in the organization provisioning request for packages `webex_suite`, `webex_meetings`, `webex_calling`.
If no timezone is specified in the provisioning request, the Webex Meetings site timezone for that package is set to a default based on the country assigned to the organization. In the case that a new organization is being created, the timezone is based on the country specified in the provisioning request. Here are the default cities/timezones for each country: | **Country** | **City [Timezones]** | | :-- | :-- | | Afghanistan | Kabul [Asia/Kabul] | | Albania | Amsterdam [Europe/Amsterdam] | | Algeria | West Africa [Africa/Douala, Africa/Lagos] | | Andorra | Amsterdam [Europe/Amsterdam] | | Angola | West Africa [Africa/Douala, Africa/Lagos] | | Anguilla | Halifax [America/Puerto_Rico, America/Halifax] | | Antigua and Barbuda | Halifax [America/Puerto_Rico, America/Halifax] | | Argentina | Buenos Aires [America/Argentina/La_Rioja, America/Argentina/Jujuy, America/Argentina/San_Luis, America/Argentina/Catamarca, America/Argentina/Santiago_del_Estero, America/Argentina/Ushuaia, America/Buenos_Aires, America/Argentina/Cordoba, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/Tucuman, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Buenos_Aires] | | Armenia | Yerevan [Asia/Yerevan] | | Aruba | Halifax [America/Puerto_Rico, America/Halifax] | | Australia | Sydney [Australia/Sydney] | | Austria | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Azerbaijan | Baku [Asia/Baku] | | Bahamas | Indiana [America/Indianapolis, America/Fort_Wayne] | | Bahrain | Riyadh [Asia/Riyadh] | | Bangladesh | Mumbai [Asia/Kolkata] | | Barbados | Halifax [America/Puerto_Rico, America/Halifax] | | Belarus | Moscow [Europe/Moscow] | | Belgium | Brussels [Europe/Brussels] | | Belize | Chicago [America/Chicago, America/Costa_Rica] | | Benin | West Africa [Africa/Douala, Africa/Lagos] | | Bermuda | Halifax [America/Puerto_Rico, America/Halifax] | | Bhutan | Almaty [Asia/Almaty] | | Bolivia | La Paz [America/La_Paz] | | Bonaire, Saint Eustatius and Saba | Halifax [America/Puerto_Rico, America/Halifax] | | Bosnia and Herzegovina | Amsterdam [Europe/Amsterdam] | | Botswana | Windhoek [Africa/Windhoek] | | Brazil | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Brunei Darussalam | Kuala Lumpur [Asia/Kuala_Lumpur] | | Bulgaria | Helsinki [Europe/Helsinki] | | Burundi | Windhoek [Africa/Windhoek] | | Cambodia | Bangkok [Asia/Bangkok, Asia/Saigon] | | Cameroon | West Africa [Africa/Douala, Africa/Lagos] | | Canada | Toronto [America/Montreal, America/Toronto] | | Cape Verde | Cape Verde [Atlantic/Cape_Verde] | | Cayman Islands | Panama [America/Panama] | | Chile | Santiago [America/Santiago, America/Punta_Arenas, Pacific/Easter] | | China | Beijing [Asia/Hong_Kong, Asia/Shanghai] | | Colombia | Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos] | | Comoros | Nairobi [Africa/Nairobi] | | Costa Rica | Chicago [America/Chicago, America/Costa_Rica] | | Cote d'Ivoire | London [Europe/London, Europe/Dublin] | | Croatia | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Curacao | Caracas [America/Caracas] | | Cyprus | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | Czech Republic | Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague] | | Denmark | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Dominican Republic | Caracas [America/Caracas] | | Ecuador | Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos] | | Egypt | Cairo [Africa/Cairo] | | El Salvador | Chicago [America/Chicago, America/Costa_Rica] | | Estonia | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | Ethiopia | Nairobi [Africa/Nairobi] | | Faroe Islands | London [Europe/London, Europe/Dublin] | | Fiji | Fiji [Pacific/Fiji] | | Finland | Helsinki [Europe/Helsinki] | | France | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | French Guiana | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | French Polynesia | Honolulu [Pacific/Honolulu] | | Georgia | Istanbul [Europe/Istanbul] | | Germany | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Ghana | London [Europe/London, Europe/Dublin] | | Greece | Athens [Europe/Athens] | | Greenland | Nuuk [America/Godthab] | | Guadeloupe | Caracas [America/Caracas] | | Guatemala | Mexico City [America/Mexico_City] | | Honduras | Tegucigalpa [America/Tegucigalpa] | | Hong Kong | Beijing [Asia/Hong_Kong, Asia/Shanghai] | | Hungary | Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague] | | Iceland | Reykjavik [Atlantic/Reykjavik] | | India | Colombo [Asia/Colombo] | | Indonesia | Jakarta [Asia/Jakarta] | | Iraq | Riyadh [Asia/Riyadh] | | Ireland | London [Europe/London, Europe/Dublin] | | Isle of Man | London [Europe/London, Europe/Dublin] | | Israel | Tel Aviv [Asia/Tel_Aviv, Asia/Jerusalem] | | Italy | Rome [America/Tunis, Europe/Malta, Europe/Rome] | | Jamaica | Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos] | | Japan | Tokyo [Asia/Tokyo] | | Jersey | London [Europe/London, Europe/Dublin] | | Jordan | Amman [Asia/Amman] | | Kazakhstan | Almaty [Asia/Almaty] | | Kenya | Nairobi [Africa/Nairobi] | | Korea, Republic of | Seoul [Asia/Seoul] | | Kuwait | Riyadh [Asia/Riyadh] | | Kyrgyzstan | Almaty [Asia/Almaty] | | Lao People's Democratic Republic | Bangkok [Asia/Bangkok, Asia/Saigon] | | Latvia | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | Lebanon | Windhoek [Africa/Windhoek] | | Libyan Arab Jamahiriya | Windhoek [Africa/Windhoek] | | Liechtenstein | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Lithuania | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | Luxembourg | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Macao | Beijing [Asia/Hong_Kong, Asia/Shanghai] | | Macedonia | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Madagascar | Nairobi [Africa/Nairobi] | | Malawi | Windhoek [Africa/Windhoek] | | Malaysia | Kuala Lumpur [Asia/Kuala_Lumpur] | | Maldives | Yekaterinburg [Asia/Yekaterinburg] | | Mali | London [Europe/London, Europe/Dublin] | | Malta | Rome [America/Tunis, Europe/Malta, Europe/Rome] | | Marshall Islands | Marshall Islands [Pacific/Majuro] | | Martinique | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Mauritius | Abu Dhabi, Muscat [Asia/Dubai] | | Mayotte | Nairobi [Africa/Nairobi] | | Mexico | Mexico City [America/Mexico_City] | | Moldova, Republic of | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Monaco | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Mongolia | Beijing [Asia/Hong_Kong, Asia/Shanghai] | | Montenegro | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Morocco | Casablanca [Africa/Casablanca] | | Mozambique | Windhoek [Africa/Windhoek] | | Namibia | Windhoek [Africa/Windhoek] | | Nepal | Kathmandu [Asia/Kathmandu] | | Netherlands | Amsterdam [Europe/Amsterdam] | | New Caledonia | Solomon Is [Pacific/Guadalcanal] | | New Zealand | Wellington [Pacific/Auckland] | | Nicaragua | Tegucigalpa [America/Tegucigalpa] | | Nigeria | West Africa [Africa/Douala, Africa/Lagos] | | Norway | Oslo [Europe/Oslo] | | Oman | Abu Dhabi, Muscat [Asia/Dubai] | | Pakistan | Islamabad [Asia/Karachi] | | Palestinian Territory | Tel Aviv [Asia/Tel_Aviv, Asia/Jerusalem] | | Panama | Panama [America/Panama] | | Papua New Guinea | Guam [Pacific/Guam] | | Paraguay | Asuncion [America/Asuncion] | | Peru | Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos] | | Philippines | Beijing [Asia/Hong_Kong, Asia/Shanghai] | | Poland | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Portugal | London [Europe/London, Europe/Dublin] | | Puerto Rico | Halifax [America/Puerto_Rico, America/Halifax] | | Qatar | Riyadh [Asia/Riyadh] | | Reunion | Abu Dhabi, Muscat [Asia/Dubai] | | Romania | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | Russian Federation | Moscow [Europe/Moscow] | | Rwanda | Windhoek [Africa/Windhoek] | | Saint Kitts and Nevis | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Saint Lucia | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Saint Martin | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Saint Vincent and the Grenadines | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | San Marino | Rome [America/Tunis, Europe/Malta, Europe/Rome] | | Saudi Arabia | Riyadh [Asia/Riyadh] | | Senegal | London [Europe/London, Europe/Dublin] | | Serbia | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | Seychelles | Abu Dhabi, Muscat [Asia/Dubai] | | Singapore | Singapore [Asia/Singapore] | | Sint Maarten | Caracas [America/Caracas] | | Slovakia | Prague [Europe/Ljubljana, Europe/Budapest, Europe/Zagreb, Europe/Prague] | | Slovenia | Paris [Europe/Paris, Europe/Luxembourg, America/Monaco, Europe/Copenhagen] | | South Africa | Pretoria [Africa/Johannesburg] | | Spain | Madrid [Europe/Gibraltar, Europe/Madrid] | | Sri Lanka | Colombo [Asia/Colombo] | | Suriname | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Sweden | Stockholm [Europe/Stockholm] | | Switzerland | Berlin [Europe/Berlin, Europe/Warsaw, Europe/Vienna, America/Vaduz, Europe/Zurich] | | Taiwan | Taipei [Asia/Taipei] | | Tajikistan | Yekaterinburg [Asia/Yekaterinburg] | | Tanzania, United Republic of | Nairobi [Africa/Nairobi] | | Thailand | Bangkok [Asia/Bangkok, Asia/Saigon] | | Timor-Leste | Seoul [Asia/Seoul] | | Togo | London [Europe/London, Europe/Dublin] | | Tonga | Tonga [Pacific/Tongatapu] | | Trinidad and Tobago | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Tunisia | West Africa [Africa/Douala, Africa/Lagos] | | Turkey | Istanbul [Europe/Istanbul] | | Turkmenistan | Yekaterinburg [Asia/Yekaterinburg] | | Turks and Caicos Islands | Bogota [America/Guayaquil, America/Bogota, America/Lima, America/Galapagos] | | Uganda | Nairobi [Africa/Nairobi] | | Ukraine | Bucharest / Chisinau [Europe/Tallinn, Asia/Nicosia, Europe/Bucharest, Europe/Riga, Europe/Kiev, Europe/Vilnius] | | United Arab Emirates | Abu Dhabi, Muscat [Asia/Dubai] | | United Kingdom | London [Europe/London, Europe/Dublin] | | United States | San Francisco [America/Los_Angeles] | | United States Minor Outlying Islands | Honolulu [Pacific/Honolulu] | | Uruguay | Montevideo [America/Montevideo] | | Uzbekistan | Yekaterinburg [Asia/Yekaterinburg] | | Venezuela | Caracas [America/Caracas] | | Vietnam | Bangkok [Asia/Bangkok, Asia/Saigon] | | Virgin Islands, U.S. | Brasilia [America/Cuiaba, America/Sao_Paulo, America/Porto_Velho, America/Eirunepe, America/Campo_Grande, America/Belem, America/Recife, America/Bahia, America/Noronha, America/Araguaina, America/Boa_Vista, America/Manaus, America/Santarem, America/Fortaleza, America/Maceio, America/Rio_Branco] | | Zambia | Cairo [Africa/Cairo] | | Zimbabwe | Cairo [Africa/Cairo] | In the event of a problem with converting the country to a Webex Meetings Site Timezone, the following default per cluster value will be used: | **Cluster** | **City [Timezones for this city]** | | :-- | :-- | | US-A (ACHM) | New York [America/New_York] | | US-B (AORE) | San Francisco [America/Los_Angeles] | | EU (AFRA) | London [Europe/London, Europe/Dublin] | ## Provisioning Precheck API Info Codes This table defines the Info codes used by the Wholesale Provisioning Precheck APIs. | Info Code | Description | |---|--| | 100 | Provisioning preCheck validation successful. | | 101 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. | | 102 | Provisioning will succeed, user specified in the request will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. | | 103 | Provisioning will succeed, user specified by 'email' exists in a Consumer/Self Sign-up organization with a pending status and will be automatically moved to the same organization as the user specified by 'primaryEmail' or other customer identifier. | | 104 | Provisioning will succeed, user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user specified by 'primaryEmail' or other customer identifier. | | 105 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. User specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. | | 106 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. User specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. | | 107 | Provisioning will succeed, user/customer specified in the request already has a Webex Organization, the provisioned package will be attached to this organization. | | 108 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. Both the user specified by 'primaryEmail' and the user specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. | | 109 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. The user specified by 'primaryEmail' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. The user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. | | 110 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be added to the same organization as the user/customer specified by 'primaryEmail'. | | 111 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first. The user specified by 'primaryEmail' will be automatically moved from the Consumer/Self Sign-up organization to a new Webex organization. The user specified by 'email' will be added to the same organization as the user/customer specified by 'primaryEmail'. | | 112 | Provisioning will succeed, user/customer specified by 'primaryEmail' and user specified by 'email' already have the same existing Webex Organization. The user/customer specified by 'primaryEmail' must be provisioned first, any provisioned package will be attached to these users and their organization. | | 113 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be automatically moved from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. | | 114 | Provisioning will succeed, user/customer specified by 'primaryEmail' must be provisioned first, this user/customer already has a Webex Organization, any provisioned package will be attached to this user/organization. The user specified by 'email' will be moved with their consent from the Consumer/Self Sign-up organization to the same organization as the user/customer specified by 'primaryEmail'. | | 115 | Provisioning will succeed, the user specified by 'email' in the request is already a part of the requested Webex Organization, the provisioned package will be attached to this user. | | 116 | Provisioning will succeed, user/customer specified by 'primaryEmail' or other customer identifier already has a Webex Organization, any provisioned package will be attached to this user/organization. | ## API Error Codes These APIs return standard HTTP status codes for request responses. For more information on standard HTTP status codes, please see [Webex REST API Basics](/docs/api/basics#api-errors). The following error codes may appear in API Error responses, or included in responses to Wholesale Get/Create/List API requests. These are complementary to the overall HTTP Status codes and provide additional clarity on the reason for the error.

This list of error codes is shared between Webex Wholesale and Webex for BroadWorks; it contains codes common to both offerings, as well as offering-specific codes.

| Error Code | Detail | HTTP Status Code | Possible in Subscriber response? | |---|---|---|---| | 1001 | **Null Parameter**
A mandatory parameter has not been specified in the API request. The `description` and `fieldName` attributes provide further detail on the missing parameter. | 400 | No | | 1002 | **Invalid Parameter Size**
A parameter in the API request is outside the bounds of expected size. The `description` and `fieldName` attributes provide further detail on the invalid parameter and the size restrictions that apply.

| 400 | No | | 1003 | **Invalid Parameter Format**
A parameter in the API request is not correctly formatted.
**Common Cause:**

Webex for BroadWorks:
- `email` or `userId` parameter in Provision Subscriber request are not in valid email address format. The specification of a valid email can be found in [RFC 2822](https://tools.ietf.org/html/rfc2822).

`primaryPhoneNumber` parameter in Provision/Update Subscriber is not a valid BroadWorks phone number.

`mobilePhoneNumber` parameter in Provision/Update Subscriber is not a valid mobile phone number

`language` parameter in Provision Subscriber request is not in ISO 639-1 format.

The package type specified in the Provision/Update Subscriber request is not one of `softphone`, `basic`, `standard` or `premium`.

`provisioningId` parameter in Precheck BroadWorks Subscriber request is not in valid format.

Webex Wholesale:
- The `email` query parameter is not in valid email address format. The specification of a valid email can be found in [RFC 2822](https://tools.ietf.org/html/rfc2822). Along with the RFC 2822 the email username can only contain only letters, digits, single quote and the following characters: # @ $ % & + - = ? ; . \ \| _ ~ ! \` ^ { }.

The `personId` query parameter is not valid.

`firstName` or `lastName` parameter in Provision a Wholesale Subscriber request are not valid. The specification of a valid name is it cannot contain %, #, <, >, backslash, forward slash and quote characters.

**Possible Solutions:**

Please follow the respective API docs in Wholesale Organization Provisioning APIs or Wholesale Subscriber Provisioning APIs or Webex for BroadWorks Subscriber Provisioning APIs section. | 400 | No | | 1004 | **Invalid Query Parameter**
The query parameter specified in Subscriber or Customer Search/List API request is invalid.

**Common Cause:**

Webex for Broadworks:
- The `email` query parameter is not in valid email address format. The specification of a valid email can be found in [RFC 2822](https://tools.ietf.org/html/rfc2822).

The `personId` query parameter is not valid.

Webex Wholesale:
- The `customerId` query parameter is not valid.

The `externalCustomerId` query parameter is not valid.

| 400 | No | | 1005 | **Invalid or Bad HTTP request**
The HTTP request message specified is either bad or invalid.

**Common Cause:**

The HTTP request message has a typographical error
The HTTP request message is missing a required header e.g. `Content-Length`

Refer to [RFC 2616](https://datatracker.ietf.org/doc/html/rfc2616) Hypertext Transfer Protocol for more details. | 400 | No | | 2001 | **Subscriber Not Found**
The `subscriberId` specified in an API Request to Get, Update, Delete a Subscriber could not be found

**Common Cause:**

The subscriber in question was previously deleted.
The `subscriberId` specified is invalid.

| 404 | No | | 2002 | **Subscriber pre-exists in another Cisco Webex Organization**
The subscriber has previously mapped to a new or existing Webex Organization. However, the email address associated with this subscriber has been found in a different Webex organization. Cisco cannot automatically move this subscriber to the desired organization and so provisioning fails.

**Common Cause:**

The subscriber in question already has free or paid Webex services using this email address in another Webex organization.
The email address supplied is incorrect.

**Possible Solutions:**

Validate that the supplied email is correct.
Confirm with the customer/subscriber that their enterprise has been mapped to the correct Webex organization.
Work with the customer/subscriber to close their existing Cisco Webex account or change the email address associated with that account.
Supply an alternate email address for the subscriber.

| 409 | Yes | | 2003 | **Subscriber Update Not Allowed User Not Found**
The subscriber update operation is not allowed because the corresponding user cannot be found.

**Common Cause:**

User does not exist in the Cisco Webex Organization.

**Possible Solutions:**

Use the `People API` to check if the user exists, if not, use `Delete Subscriber API` to delete the subscriber and reprovision it.

| 404 | No | | 2004 | **Webex Organization Mismatch**
The subscriber Update API request failed as the subscriber is unexpectedly associated with a different Webex Organization to the one in which they were originally provisioned.
**Common Cause:**
Another Organization has claimed the subscriber, triggering an automated move of the subscriber into a new Webex organization.
**Possible Solutions:**
If the subscriber has been claimed by another organization, then they can no longer obtain Webex for BroadWorks services as part of their existing BroadWorks enterprise.

Perform a Delete Subscriber operation to clean up Webex for BroadWorks provisioning for the subscriber.
Then work with the customer/subscriber in question to determine next steps.

| 409 | No | | 2005 | **Package Type Not Supported**
The package type specified in the Provision/Update request is not supported.
**Note:** This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled.

**Common Cause:**

Webex for Broadworks: The package type specified is syntactically valid (one of `softphone`, `basic`, `standard` or `premium`), however that specific package type is not currently supported in this mode of operation.

Webex Wholesale: The package type specified is syntactically valid (one of `common_area_calling`, `webex_calling`, `webex_suite`, `webex_meetings` or `webex_voice`), however that specific package type is not currently supported in this mode of operation.

**Possible Solution:**

Perform the API request again with a supported package type.

| 400 | No | | 2006 | **Insufficient Privileges**
You do not have sufficient privileges to perform update/delete operations on this subscriber.

**Common Cause:**

The Partner Organization associated with the access token specified in the API request does not match the Partner Organization with which the subscriber was originally provisioned.

**Possible Solution:**

Check to ensure the application making this API request has been authorized by a full administrator within the correct Partner Organization.

| 403 | No | | 2007 | **Broadworks Enterprise not mapped to Cisco Webex Organization**
The Provision Subscriber API request could not be processed as the associated Broadworks Enterprise is not mapped to a pre-existing Webex Organization.
**Note:** This only applies where the associated Customer Template is configured with Automatically Create New Organizations in Control Hub disabled.
**Common Cause:**

The target Webex Organization has not been created and pre-existing in Control Hub.
The target Webex Organization has not been manually mapped to their Broadworks Enterprise by the Partner Administrator.

**Possible Solution:**

If Webex organization does not exist, you must place an order for the customer via Cisco Commerce for agreed Product SKUs to trigger the organization creation.
On Control Hub, map the customer organization to their Broadworks enterprise as required.

| 404 | No | | 2008 | **Subscriber Provisioning Request Already Being Processed**
A Subscriber Provision or Update API request for the same subscriber is already in being processed by Cisco Webex.

**Common Cause:**

Two Subscriber Provision or Update API requests have been sent concurrently for the same subscriber. Cisco Webex will reject any subsequent Provision/Update requests until it has responded to the initial request.

**Possible Solution:**

Wait until you have received a response to the initial API request before performing another operation for the same subscriber.

| 400 | No | | 2009 | **BroadWorks User ID Already Exists**
A subscriber with the same BroadWorks `userId` and from the same BroadWorks Cluster already exists.
**Common Cause:**
The request has been rejected as BroadWorks UserID is unique to a BroadWorks Cluster and a subscriber with this `userId` from this BroadWorks Cluster already exists in the Cisco Webex database.
**Possible Solutions:**

Validate the `userId` & `provisioningId` supplied in this request are correct. The `provisioningId` identifies the Customer Template and associated BroadWorks cluster.
If necessary, remove the existing subscriber with the same BroadWorks UserId.

| 409 | Yes | | 2010 | **Email Address Already In Use**
The `email` specified in the request is already being used by another provisioned BroadWorks subscriber.
**Common Cause:**

A subscriber has previously been provisioned using the same email address.
Note that this existing subscriber may have been provisioned by a different BroadWorks Service Provider

**Possible Solutions:**

Validate the correct email address has been specified in this attempt to provision a new subscriber.
If so, use the subscriber search API to query your list of subscribers using the email address as a query parameter.
- If you find a match, you can determine whether or not the existing subscriber has been provisioned incorrectly.
- If no result is found, then the subscriber associated with the email address is likely managed by an alternate BroadWorks Service Provider; You will need to work with the subscriber and customer in question to determine next steps.

| 409 | Yes | | 2011 | **No Organization Administrator**
The Subscriber Provision/Update operation could not be processed as the target customer organization on Cisco Webex does not have an administrator with *Full Administrator* role.

**Common Cause:**

All Wholesale Customer Organizations on Cisco Webex should have an administrator with *Full Administrator* role.
The administrator may be been deleted prior to this operation being performed.

**Possible Solutions:**

Assign the *Full Administrator* role to an existing user in this organization before trying again.
If there are no users in the organization, manually create a new user via Control Hub and apply the *Full Administrator role*.

| 409 | Yes | | 2012 | **Subscriber is already entitled to Webex Calling**
The subscriber cannot be provisioned for Webex for BroadWorks because they are already entitled to Webex Calling.
**Possible Solutions:**

Remove the conflicting entitlement before provisioning the affected subscriber (the subscriber will use BroadWorks calling, instead of their previous option).
Provision the subscriber with a different email address (the subscriber will have two distinct Webex user IDs).

| 409 | No | | 2013 | **Unknown Provisioning ID**
The supplied `provisioningId` does not map to any of your configured Customer Templates.
**Common Cause:**

The provisioning ID is an identifier for a specific Customer Template you have configured on Partner Hub. The Provisioning ID specified in this request does not map to any of your configured Customer Templates.
During the Partner PreCheck API which prechecks a given set of parameters to indicate whether the provisioning operation will succeed or fail, the provisioningId provided in the request is not associated with the partner making the request.

**Possible Solutions:**

Check that your expected customer template exists in Partner Hub.
Check that the provisioning ID displayed for that template matches what you used in the request.
Provide the correct provisioning ID associated with the partner.

| 404 | No | | 2014 | **Provisioning ID Mismatch**
The `provisioningId` specified in this request does not match the expected Provisioning ID for this subscriber’s enterprise.
**Common Cause:**
All subscribers within an enterprise must be provisioned with the same provisioning ID. The provisioning ID specified in this request does not match the provisioning ID used to provision previous subscribers in this enterprise.
**Possible Solution:**
Ensure the Provisioning ID in your request matches the expected Provisioning ID for this enterprise.

You can determine this by performing a GET /enterprises request for the enterprise in question.
You may also determine this by performing a GET /subscribers request, supplying the BroadWorks userID of a previously provisioned subscriber from that enterprise.
Alternatively, you may manually determine this via Partner Hub & Control Hub by performing the following steps:
1. As a Sales Full Administrator within your Partner organization, sign into Partner Hub and find the associated Customer in your Customers list.
2. Click on the Customer and select "View Customer" to open the Customer's Control Hub view.
3. From the Customer's Control Hub Overview page, click on "..." on the "Webex Services" card and select "Manage Services".
4. On the "Services" page you should see a "BroadWorks Calling" card, where the Template name is listed.
5. Return to Partner Hub and view the specified Customer Template to find the associated Provisioning ID.

| 400 | No | | 2015 | **Enterprise ID Conflict**
The `spEnterpriseId` specified in this request conflicts with a Service Provider or Enterprise already provisioned from this BroadWorks Cluster.
**Common Cause:**
This API enforces uniqueness validation for any BroadWorks *Enterprise ID* or *Service Provider ID* values specified in the `spEnterpriseId` parameter. This is to align with more general BroadWorks uniqueness constraints:

On the BroadWorks cluster, there cannot be a *Service Provider ID* and *Enterprise ID* with the same value.
Therefore Webex will reject a Subscriber Provisioning request with this error code if:
- An *Enterprise ID* specified in `spEnterpriseId` matches a *Service Provider ID* included in a previous request from that BroadWorks Cluster.
- A *Service Provider ID* specified in `spEnterpriseId` matches a *Enterprise ID* included in a previous request from that Cluster.

If you encounter this error, it is an indication of issue with how you have generated the `spEnterpriseId` in (this or previous) Subscriber Provision requests for this BroadWorks cluster:

You may have incorrectly included the subscriber's *Group ID* where the enterprise is configured as an Enterprise on BroadWorks.
You may have incorrectly omitted the subscriber's *Group ID* where the enterprise is configured as an Group under a Service Provider on BroadWorks.

See the [Enterprise ID](#enterprise-id) section below for more information on how to generate spEnterpriseId parameter.
The key point is that even though you encounter the error on this request, the root cause be be a misconfigured `spEnterpriseId` on a previous request from this cluster.
**Possible Solutions:**
Perform the following steps to identify and fix the issue:

Ensure you have specified the correct `spEnterpriseId` in this request per the [Enterprise ID](#enterprise-id) rules defined below.
If the `spEnterpriseId` in this request is correct, then it is likely that previous subscriber provisioning request(s) specified an invalid spEnterpriseId.
- You will need to review all provisioned/pending subscribers and their associated spEnterpriseId.
- If a misconfigured `spEnterpriseId` is found then a series of steps are required to clean up the subscribers/enterprises configured in error:
  1. Deprovision all subscribers with misconfigured `spEnterpriseId` using *DELETE /broadworks/subscribers/{subscriberId}*.
  2. For each misconfigured `spEnterpriseId`, use the Enterprise Search API (*GET /broadworks/enterprises*) to retrieve any associated orgId.
  3. For each associated orgId, you have two options to clean up those organizations:
    1. Permanently delete the organization from Webex using *DELETE /organizations/{orgId}* API.
      - This requires you to first fully delete all users from the organization using the *DELETE /people/{personId}*.
      - This option should only be used if this organization was newly created as part of provisioning the subscriber with an incorrect spEnterpriseId.
      - For organizations that pre-existed on Webex, proceed to the alternate option below.
    2. Manually clear any mapping between the organization and the misconfigured `spEnterpriseId` from Control Hub using the following steps.
      - As a Sales Full Administrator within your Partner organization, sign into Partner Hub and find the associated Customer in your Customers list.
      - Click on the Customer and select "View Customer" to open the Customer's Control Hub view.
      - From the Customer's Control Hub Overview page, click on "..." on the "Webex Services" card and select "Manage Services".
      - On the "Services" page you should see a "BroadWorks Calling" card.
      - Click on the "Clear Configuration" button (This button only appears once all subscribers have been deprovisioned above).

Once these deprovisioning steps have been completed, all subscribers can now be reprovisioned using the correct spEnterpriseId.
If you cannot identify the cause of the conflict, please raise a Support ticket. | 409 | No | | 2016 | **Customer and Partner Org Region Mismatch**
**Common Cause:**
Partner is trying to on-board a pre-existing user or a new user using an email domain which is claimed by a Webex Organization in a different region.
**Possible Solution:**
Ensure the user and partner are in the same region (for example: a user in the EU cannot be provisioned into US region or vice versa).
| 409 | No | | 2017 | **Unable to provision Subscriber into an Existing Webex Organization**
The Subscriber Provision API request was rejected as an existing Webex Organization has been discovered either with subscriber’s exact matching email or domain of the the email, but automatic subscriber provisioning into this Webex Organization is forbidden.

**Common Cause:**

This should only be encountered when provisioning the initial Subscriber in the customer/enterprise.
In that case, provisioning of the Subscriber into an existing Webex Organization is forbidden where there is no pre-existing relationship on Webex between the Partner and discovered Organization **plus** at least one of the following scenarios is true:
1. The discovered Organization has more than 100 users.
2. The Organization was discovered based on claimed domain only (i.e., the subscriber's email address was not found in the Organization, but the Organization has claimed the subscriber's email domain).

**Possible Solutions:**

Ensure that the email supplied for this subscriber is valid.

| 409 | No | | 2018 | **Webex Organization managed by a different Partner**
**Webex for Broadworks**
The Subscriber Provision API request failed as the Webex Organization associated with this subscriber already has Webex for BroadWorks services with a different Partner.
**Common Cause:**

The email address supplied is incorrect.
The subscriber had been previously provisioned under a different Partner Organization.
During the Partner PreCheck API which prechecks a given set of parameters to indicate whether the provisioning operation will succeed or fail, the customer primaryEmail in the request is associated with a customer not managed by the Partner making the request.

**Possible Solutions:**

Ensure that the supplied email in the request is correct.
If the supplied email in the request is correct, then it is likely that the customer organization associated with this BroadWorks subscriber was already created under a different Partner Organization. Then work with the customer/subscriber in question to determine next steps.
Ensure that the supplied customerInfo primaryEmail for the customer is associated with the Partner Organization.

**Webex Wholesale**
The Customer Provision API request failed as the Webex Organization associated with this customer already has Webex Wholesale services with a different Partner.
**Common Cause:**

The email address supplied is incorrect.
The customer had been previously provisioned under a different Partner Organization.
During the Partner PreCheck API which prechecks a given set of parameters to indicate whether the provisioning operation will succeed or fail, the customer primaryEmail in the request is associated with a customer not managed by the Partner making the request.

**Possible Solutions:**

Ensure that the supplied email in the request is correct.
If the supplied email in the request is correct, then it is likely that the customer organization associated with this Wholesale customer was already created under a different Partner Organization. Then work with the customer in question to determine next steps.
Ensure that the supplied customerInfo primaryEmail for the customer is associated with the Partner Organization.

| 409 | No | | 2019 | **Domain In Email Address Claimed by a different Webex Organization**
The Subscriber Provision API request was rejected as the email specified in the request uses a domain which is already claimed by a different Webex Organization.
**Common Cause:**

You are trying to provision a subscriber into an existing Webex Organization, associated with the spEnterpriseId parameter in the request.
However the subscriber's email address has a domain claimed by an alternate Webex Organization.
As that alternate Webex Organization has claimed this domain, this subscriber cannot be provisioned - with that email address - into your chosen Organization.

**Possible Solutions:**

Ensure that the correct email address is provided in the request.
Ensure you have specified the expected spEnterpriseId in this request.

| 409 | No | | 2020 | **Subscriber Update Not Allowed Due To Conflicting Current Status**
The subscriber update operation is not allowed because of the current provisioning status of the subscriber.

**Common Cause:**

Subscriber Provisioning/Update is currently in progress - subscriber status is `provisioning` or `updating`.
Subscriber provisioning had previously failed and the subscriber status is `error`.

**Possible Solutions:**

Check current Subscriber Status.
If Subscriber Provisioning is in progress, wait until status transitions to a final status of (`provisioned` or `error`) before proceeding with appropriate next step.
If subscriber is in `error` status, you will need to send a new Provision Subscriber API request to re-provision them.

| 409 | No | | 2023 | **Requested Billing Period is Invalid**
Create Broadworks Billing Reports failed since the requested billing period is invalid.

**Possible Solution:**

The billing period in the Create BroadWorks Billing Report API request must not be before 5 years from now

| 400 | No | | 2024 | **Billing Reports not Found**
The Get / Delete Billing Reports API request failed because the requested billing report is not found.

**Common Cause:**

Trying to GET a billing report with a reportId that does not exist in the database.
Trying to DELETE a billing report with a reportId that does not exist in the database.

**Possible Solution:**

Use a valid billing reportId that is present in the database.
To find out the list of reports for a specific partner (or/and) billing period, use [List BroadWorks Billing Reports API](/docs/api/v1/broadworks-billing-reports/list-broadworks-billing-reports) for Webex for Broadworks and in case of Webex Wholesale use [List Wholesale Billing Reports API](/docs/api/v1/wholesale-billing/list-wholesale-billing-reports).

| 404 | No | | 2025 | **Billing Reports generation is In Progress**
The request was rejected because the billing report generation is currently in progress.

**Common Cause:**

Trying to create/delete a report when its generation is still IN_PROGRESS.

**Possible Solutions:**

Webex for Broadworks:
- Use the [Get BroadWorks Billing Reports API](/docs/api/v1/broadworks-billing-reports/get-a-broadworks-billing-report) to obtain the status of the report before using [Delete a Broadworks Billing Report API](/docs/api/v1/broadworks-billing-reports/delete-a-broadworks-billing-report). Billing reports that are marked as COMPLETED/FAILED state can only be deleted. If the report that you intend to delete is IN_PROGRESS, wait and retry later.
- Use the [Get BroadWorks Billing Reports API](/docs/api/v1/broadworks-billing-reports/get-a-broadworks-billing-report) to obtain the status of the report before using [Create BroadWorks Billing Report API](/docs/api/v1/broadworks-billing-reports/create-a-broadworks-billing-report). Use Create BroadWorks Billing Report again only if the status was FAILED. Trying to create billing report operation for an already existing report would result in 2026 Billing Report Already Exists.
Webex Wholesale:
- Use the [Get Wholesale Billing Reports API](/docs/api/v1/wholesale-billing/get-a-wholesale-billing-report) to obtain the status of the report before using [Delete a Wholesale Billing Report API](/docs/api/v1/wholesale-billing/delete-a-wholesale-billing-report). Billing reports that are marked as COMPLETED/FAILED state can only be deleted. If the report that you intend to delete is IN_PROGRESS, wait and retry later.
- Use the [Get Wholesale Billing Reports API](/docs/api/v1/wholesale-billing/get-a-wholesale-billing-report) to obtain the status of the report before using [Create Wholesale Billing Report API](/docs/api/v1/wholesale-billing/create-a-wholesale-billing-report). Use Create Wholesale Billing Report again only if the status was FAILED. Trying to create billing report operation for an already existing report would result in 2026 Billing Report Already Exists.

| 409 | No | | 2026 | **Billing Report Already Exists**
Occurs when a partner tries to generate a report of a `billingStartDate` and `billingEndDate` for which the report was already generated.

**Possible Solutions:**

Webex for Broadworks:
- Make use of the [Get Broadworks Billing Reports API](/docs/api/v1/broadworks-billing-reports/list-broadworks-billing-reports) to list reports and GET the concerned report.

Use the Delete Broadworks Billing Report and Create Broadworks Billing Report APIs to recreate the billing report if required.

Webex Wholesale:
- Make use of the [Get Wholesale Billing Reports API](/docs/api/v1/wholesale-billing/list-wholesale-billing-reports) to list reports and GET the concerned report.
- Use the Delete Wholesale Billing Report and Create Wholesale Billing Report APIs to recreate the billing report if required.

| 409 | No | | 2027 | **User Migration is Pending**
User migration from trial account is pending, please wait until the user takes appropriate action to get provisioned.

**Common Cause:**

Partner admin trying to re-onboard user from trial account who is already present and is pending user migration.
Existing pending user was attempted to be onboarded by different partner.
Existing pending user was attempted to be onboarded with different userId Or spEnterpriseId.

**Possible Solutions:**

Once user from trial (consumer/self-signup) organization is deleted then user would be onboarded automatically. Please use [Get a BroadWorks Subscriber](/docs/api/v1/broadworks-subscribers/get-a-broadworks-subscriber) API to check user status.
If there is any change needed for user, please use [Update a BroadWorks Subscriber](/docs/api/v1/broadworks-subscribers/update-a-broadworks-subscriber) API once user is successfully provisioned.
If email has not been sent to the user to take appropriate action, please use the Resend Email option from the user status board in PartnerHub.

| 409 | No | | 2028 | **Invalid Billing Period**
The Billing Period provided in the request is invalid.

**Common Cause:**

After request parameter is a later date than the Before request parameter.
After request parameter is not a past date.
Before request parameter is a date prior than 5 years from now.

**Possible Solutions:**

The After-request parameter must not be later date than the Before-request parameter and must be a past date.
The Before-request parameter must not be before 5 years from now.

| 400 | No | | 2029 | **Billing Reports Forbidden Access**
Insufficient privileges to access the Billing reports APIs.

**Common Cause:**

The requesting user does not have the required privileges. The Billing Report APIs can be accessed by Partner Admins only.

**Possible Solutions:**

Webex for Broadworks:
- The user making List/Get Broadworks Billing Report API request should be authorized by a Read - Only Administrator or Full Administrator or Sales Full Administrator within the correct Partner Organization.

The user making Create/Delete Broadworks Billing Report API request should be authorized by a Full Administrator or Sales Full Administrator within the correct Partner Organization.

Webex Wholesale:
- The user making List/Get Wholesale Billing Report API request should be authorized by a Read - Only Administrator or Full Administrator or Sales Full Administrator within the correct Partner Organization.
- The user making Create/Delete Wholesale Billing Report API request should be authorized by a Full Administrator or Sales Full Administrator within the correct Partner Organization.

| 403 | No | | 2030 | **Billing Reports Server Busy**
The request failed since the server is currently busy performing other billing report creation operations.

**Possible Solution:**

Retry the billing report creation at a later time.

| 503 | No | | 2031 | **Invalid sortBy value**
Invalid value provided for the sortBy request parameter.

**Common Cause:**

Webex for Broadworks:
- Invalid value provided for the sortBy request parameter in [List Broadworks Billing Reports API](/docs/api/v1/broadworks-billing-reports/list-broadworks-billing-reports).
Webex Wholesale:
- Invalid value provided for the sortBy request parameter in [List Wholesale Billing Reports API](/docs/api/v1/wholesale-billing/list-wholesale-billing-reports).

**Possible Solution:**

The sortBy request parameter accepts only `id`,`billingPeriod` or `status` as valid values

| 400 | No | | 2032 | **User Does Not Exist In Directory Sync Organization**
User to be added does not currently exist in organization with Directory Sync enabled.
**Common Cause:**
When active directory is enabled, a user creation request cannot be made before this user is added to the active directory first.
**Possible Solution:**

The user must first be added to the organization's active directory.

| N/A | No | | 2033 | **User Information Differs from Organization Directory Record**
First Name, Last Name or Display Name is different from the organization’s active directory record.
**Common Cause:**
When trying to onboard a user, the given information is not the same as the information added in the active directory.
**Possible Solution:**

Fetch the correct First Name, Last Name or Display Name from the active directory and try onboarding the user again.

| N/A | No | | 2034 | **Organization not yet fully provisioned**
The organization must be fully provisioned in Webex before the requested operation can be performed.

**Common Cause:**

The first user in this organization has not yet completed provisioning.

**Possible Solution:**

Wait until a user has finished being provisioned in this organization and then retry the operation.

| 403 | No | | 2039 | **Workspace not found**
Workspace Not Found.

**Common Cause:**

The requested workspace does not exist and may have been previously deleted.
The specified workspaceId is invalid.

**Possible Solution:**

Use a valid workspaceId that is already provisioned.

| 404 | No | | 2040 | **Workspace name already in use**
This workspace name is already used by another workspace.

**Possible Solution:**

Change the workspace name to a unique value and retry the request.

| 409 | No | | 2042 | **Required Feature Toggle Not Enabled**
Access to the requested feature is not permitted.

**Common Cause:**

The requesting user does not have the required feature enabled.

**Possible Solution:**

The user should request that the feature toggle is enabled.

| 403 | No | | 2043 | **Broadworks Cluster not provisioned**
The Partner organization does not have any BroadWorks clusters configured

**Common Cause:**

During the Partner PreCheck API which prechecks a given set of parameters to indicate whether the provisioning operation will succeed or fail, no Broadworks cluster was found associated with the requested Partner organization.

**Possible Solution:**

The Partner Organization making the request, must have a Broadworks cluster associated.

| 403 | Yes | | 2045 | **Precheck Broadworks User already exists**
The specified subscriber is already onboarded with a package into this customer organization

**Common Cause:**

The provided broadworks subscriber is already onboarded with a package into the indicated customer organization.

| 400 | Yes | | 2046 | **Broadworks Precheck Hybrid Flow not supported**
The Precheck API does not support hybrid flow provisioning precheck validations.

| 400 | Yes | | 2047 | **Block usage of Webex Wholesale API for Webex for BroadWorks customer**
Unable to perform action on Webex Wholesale package for a customer/subscriber that is an existing Webex For BroadWorks customer.

**Possible Solution:**
Retry the request using the equivalent Webex for BroadWorks API. | 409/404 | N/A | | 2048 | **Incompatible calling package already assigned**
Unable to onboard the user to Webex for BroadWorks since the user has the Calling in Webex (Unified CM) calling package.

**Possible Solution:**
The Webex Calling package should be removed from the user in Control Hub. | 409 | N/A | | 2501 | **Invalid Organization ID**
The organization specified in the request is not associated with any valid existing Webex organization.

**Common Cause**

The customer orgId sent in the Wholesale customer provisioning request does not exist.
The customer org provided in the request is the self-signed up orgId.

**Possible Solutions:**

The Customer orgId provided in the request should be associated with pre-existing org.
The orgId should not be self signed orgId.

| 404 | No | | 2502 | **Wholesale customer is either in provisioning or updating or deleting status**
The requested operation cannot be processed because of a conflict in the current status of Customer provisioning.

**Common Cause**

The wholesale org is either in provisioning or updating or deleting status.

**Possible Solutions:**

Provision the org once it moved to provisioned or error status .

| 409 | No | | 2503 | **The externalId specified is already associated with another Wholesale customer**
The specified externalId must be unique across all Wholesale customers managed by the Partner organization. In this case, another Wholesale customer was found with the same externalId.

**Common Cause:**

The externalId specified is already associated with another Wholesale customer.

**Possible Solutions:**

Provide a unique externalId.

The wholesale Organization has not reached the provisioned status.

Onboard the subscriber once the wholesale org has reached the provisioned status.

The email provided for the subscriber is not match with broadworksUserId.

Please provide the broadwork user email in the request.

The wholesale customer is not provisioned with requested package.

Provision the subscriber with the package which is already provisioned in the wholesale org.
Update the wholesale org with required package and provision the subscriber.

An attempt was made to provision a subscriber which is already onboarded and not in ERROR state.

The broadworksUserId parameter is not provided in the request.

Please provide the valid broadworksUserId in the request.

`billingStartDate` request parameter is a later date than the `billingEndDate` request parameter.
`billingStartDate` and `billingEndDate` request parameter is a future date.

The `billingStartDate` parameter must not be later date than the `billingEndDate` parameter and must be a past date.
The billing Dates must not be a current date.
The billing Dates must not be before 5 years from now.

The sortBy request parameter accepts only `id`,`billingStartDate`, `billingEndDate` or `status` as valid input.

The Report Status request parameter accepts only `COMPLETED`,`IN-PROGRESS` or `FAILED` as valid values.

The Report Type request parameter accepts only `PARTNER`,`CUSTOMER` or `USER` as valid values.

The wholesale customer has active workspace.

Delete all the active workspace from the wholesale customer and then perform the delete operation.

The wholesale customer has active user.

Delete all the active user from the wholesale customer and then perform the delete operation.

An attempt was made to provision a subscriber under the Partner organization which does not have the required entitlement for the particular package.

The Partner organization should be assigned the entitlement for the desired onboarding package.

An attempt was made to provision a subscriber under the Partner organization which does not have the required subscription for the particular package.

The Partner organization should be assigned the subscription for the desired onboarding package.

An attempt was made to provision a subscriber with a locationId parameter which does not exist or does not belong to the specified customer organization.

Provide a valid locationId parameter in the provisioning request

Customer attempt to provision the subscriber without providing the location details. Automatic selection of customer location can't be performed when customer doesn't not have any location or customer has multiple location.

The locationId parameter was not specified.
Automatic selection of customer location could not be performed because the customer does not have any location.
Automatic selection of customer location could not be performed because the customer has multiple locations.

An attempt was made to provision a subscriber under a Partner organization which does not have a subscription identifier configured in the customer template.

Configure the subscription identifier for the partner org in the customer template.

The package is assigned with active user or workspace.

Delete the associated user or workspace from the package and then perform the package delete operation.

The request has invalid billing address of the customer.

Provide the valid billing address of the customer.

The phone number provided in the request is not available.
Phone number provided in the request is does not belong to customer.

Provide the valid phone number for the subscriber.

The extension number provided in the request is not valid.

Provide the valid extension number for the subscriber.

The Cloud Connected PSTN provider ID is null or empty in customer template.

Update the Cloud Connected PSTN provider ID in the template before provisioning.

Please provide the valid ISO2 country code of the customer.

Please provide the valid state or province code for the specified country.

Please provide the valid state or province code for the specified country.

Please provide the valid zip or postal code for the specified country.

Please provide the valid timezone of the location.

Please provide the valid language code of the location.

Please provide the valid Partner Wholesale Subscription ID.

During the Partner PreCheck API which prechecks a given set of parameters to indicate whether the provisioning operation will succeed or fail, the customer found using the primaryEmail provided and the customer found using the customerId/spEnterpriseId provided are not the same

Provide the correct primaryEmail for the customer associated with the customerId/spEnterpriseId

The `customerId` specified is invalid.

The first update request has a package parameter containing the current list of packages along with the new packages to be added.
The second update request has a package parameter containing the current list of packages (including the newly added packages), but without the packages that are intended to be removed.

The country code supplied in request is not a valid country.

Check if the `country` provided in request is correct.

The zip / postal code does not belong to the country.

Check if the `zipOrPostalCode` resides within the `country` provided in the request.

A mandatory field is missing in the address.

An attribute may be required in specific geographies, please refer to address section in the admin guide for more information.

The address supplied in the request is not valid.

One of address fields provided in the request is not valid. Check your input values.

The city does not belong to state / province and/or to the zip / postal code.

Check if the `city` resides inside the `stateOrProvince` and/or `zipOrPostalCode` provided in the request.

The state or province does belong to the zip / postal code provided.

Check if the `stateOrProvince` resides inside the `zipOrPostalCode` provided in the request.

Either `packages` or `package` field should be provided in the request
The `packages` field does not contain a valid combination of packages
One of the `packages` requires or depends on another package to be present in order to provision the user

Verify that the `primaryPhoneNumber` is not already assigned to another user or used in another location

Verify that the `extension` is not already assigned to another user

Verify that the `primaryPhoneNumber` exists and is not already assigned

Verify that the `extension` is correctly formatted

Verify that the `primaryPhoneNumber` is not a toll free number

Try the POST Wholesale Customer request again, this time supplying the encoded `orgId` parameter.

Verify the `packages` field contains wholesale only packages.

Update the calling behavior template to match the user calling behavior.

Ensure that all dependent packages associated with the Cisco Calling Plan are included in the removal request. Both the Cisco Calling Plan and its dependencies must be removed together.

Change the `orgId` to match the customer admin's
Check the supplied customer admin email address is correct and change appropriately

Contact your partner administrator to increase the limit and then try again.

Pass in the current limit or increase the limit of needed

Specifiy limits for each package

Remove `limits` from the request

Verify that the `primaryPhoneNumber` is not a non-geographical number.

Automatically Create New Organizations in Control Hub

Subscription(s) have not been established via Cisco Commerce to ensure the target Webex Organization has the necessary licenses in place.
Pre-existing Subscription(s) were established with the appropriate licenses for the Organization - but have since been suspended or cancelled.

Check status of any existing active subscriptions for the Organization from Control Hub.
Establish new subscription(s) as required via Cisco Commerce to meet the licensing requirements - using agreed Product SKUs.

The Original Service Provider Admin in the Partner Organization has since lost administrative privileges and is no longer an Admin.
The Service Provider Admin in question has changed their email address on Cisco Webex.
The Service Provider Admin in question has left or been deleted from the organization.

Trigger the BroadWorks Directory sync again via Sync-now API.
Trigger the BroadWorks Directory sync again by using the list of customers sync status through the partner template on Control Hub.

Not Applicable

Wait for some time before triggering the BroadWorks Directory sync-now API.
Wait for some time before triggering the BroadWorks Directory sync again by using the list of customers sync status through the partner template on Control Hub.

Not Applicable

Enable Broadworks directory sync for the enterprise using the Directory sync configuration API.
Enable Broadworks directory sync for the enterprise by using the list of customers sync status through the partner template on Control Hub.

Disable the Hybrid directory sync.
Enable the Broadworks directory sync using the Directory sync configuration API.
Trigger Broadworks Directory sync-now API.

The enterprise is not present in the database.
The enterprise is not managed by the specified Partner.

Verify if that enterprise really exists by executing the List BroadWorks Enterprises public API with the enterprise name.
If the enterprise exists, verify that you have the correct enterprise ID.
If it doesn’t exist, please make sure the correct spEnterpriseID was provided.