DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSubmission Checklist for Embedded Apps
Design Guidelines
MeetingsMessagingDevices
API Reference
BotsButtons and CardsIntegrationsLogin with WebexWidgetsGuest IssuerWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooksReal-time File DLP Basics
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSession TypesSpace ClassificationsTracking CodesWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Workspace SettingsWholesale Billing ReportsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Integrations and AuthorizationWebex for BroadWorksWebex for WholesaleWholesale and Broadworks Common Guide
Reference
BroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWholesale Billing ReportsWholesale Customers
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
Wholesale Subscribers
Contact Center
Overview
Devices
Overview
Guides
DevicesWorkspace Integrations Guide
Reference
Device ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooksWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooksButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
Webex Assistant Skills
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
Overview
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesVideo MeshWebex Calling Detailed Call HistoryWebex Calling Organization SettingsWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace SettingsWebhooksWholesale Billing ReportsWholesale Customers
GETList Wholesale Customers
POSTProvision a Wholesale Customer
GETGet a Wholesale Customer
PUTUpdate a Wholesale Customer
DELETERemove a Wholesale Customer
POSTPrecheck a Wholesale Customer Provisioning
Wholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

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.

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.

PUT/v1/wholesale/customers/{customerId}
URI Parameters
customerId
stringrequired

A unique identifier for the customer to be updated.

Body Parameters
externalId
string

External ID of the Wholesale customer.

packages
array[string]required

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.

Possible values: common_area_calling, webex_calling, webex_meetings, webex_suite, webex_voice
address
object

Billing Address of the customer.

addressLine1
stringrequired

AddressLine1.

addressLine2
string

AddressLine2.

city
stringrequired

City of the customer.

stateOrProvince
string

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.

zipOrPostalCode
string

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.

country
stringrequired

ISO2 country code of the customer size = 2.

provisioningParameters
object

Provisioning parameters are required when updating an existing package.

calling
object
location
objectrequired
name
stringrequired

Name of the wholesale customer office.

address
objectrequired

Address of the wholesale customer.

addressLine1
stringrequired
addressLine2
string
city
stringrequired
stateOrProvince
string

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.

zipOrPostalCode
string

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.

country
stringrequired
timezone
stringrequired

Customer timezone for calling package.

language
stringrequired

Determine language for all generated emails and voice announcements.

emergencyLocationIdentifier
string

SIP Header for any emergency calls from this location.

numbers
array[string]

List of numbers to be assigned to the location.

+17205557878
string
+17205557879
string
+17205557880
string
+17205557881
string
mainNumber
string

Main number of the Wholesale customer.

meetings
object
timezone
string

Customer timezone for meetings package.

Response Properties
url
string

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.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
PUT
/v1/wholesale/customers/
Log in to try the API.
Header
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.
  • Request
  • Response
https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4
{
  "externalId": "c1677a16-557a-4fb4-b48f-24adde57ec99",
  "packages": [
    "common_area_calling",
    "webex_calling",
    "webex_meetings",
    "webex_suite",
    "webex_voice"
  ],
  "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",
        "numbers": [
          "+17205557878",
          "+17205557879",
          "+17205557880",
          "+17205557881"
        ],
        "mainNumber": "+17205557878"
      }
    },
    "meetings": {
      "timezone": "America/Los_Angeles"
    }
  }
}
202 / Accepted
{
    "url": "https://webexapis.com/v1/wholesale/customers/Y2lzY29zcGFyazovL3VzL0VOVEVSUFJJU0UvNTJjZjU3NmQtNjBhOC00MDdhLWIyMmMtNDY3YzUxNTkxOTA4",
}

Connect

Support

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

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