Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex BroadWorks Subscribers API

The BroadWorks Subscribers API from Webex — 4 operation(s) for broadworks subscribers.

Webex BroadWorks Subscribers API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BroadWorks Subscribers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

7 operations 4 paths 4 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex BroadWorks Subscribers API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

BroadWorks Subscribers 7
GET
/broadworks/subscribers
List BroadWorks Subscribers
List BroadWorks Subscribers 10 params → 200400401403404405409410
POST
/broadworks/subscribers
Provision a BroadWorks Subscriber
Provision a BroadWorks Subscriber body → 200400401403404405409410
GET
/broadworks/subscribers/{subscriberId}
Get a BroadWorks Subscriber
Get a BroadWorks Subscriber 1 param → 200400401403404405409410
PUT
/broadworks/subscribers/{subscriberId}
Update a BroadWorks Subscriber
Update a BroadWorks Subscriber 1 param body → 200400401403404405409410
DELETE
/broadworks/subscribers/{subscriberId}
Remove a BroadWorks Subscriber
Remove a BroadWorks Subscriber 1 param → 204400401403404405409410
POST
/broadworks/subscribers/validate
Precheck a Broadworks Subscriber Provisioning
Precheck a Broadworks Subscriber Provisioning body → 200400401403404405409410
POST
/subscribers/{subscriberId}/emails/consentMove
Send Consent User Move Email to Pending Broadworks Subscribers
Send Consent User Move Email to Pending Broadworks Subscribers 1 param → 204400401403404405409429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Subscriber (17 properties), Error (2 properties), SubscriberProvisioningPrecheckResponse (2 properties), SubscriberListResponse (1 property). Each schema is shown below with its type and property counts.

SubscriberProvisioningPrecheckResponse
object
2 properties
Subscriber
object
17 properties
Error
object
2 properties
SubscriberListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-broadworks-subscribers-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API