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 Contact List Management API

Operations for managing contact lists and contacts

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

Tagged areas include Contact List Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

5 operations 5 paths 10 schemas 1 GET2 PATCH2 POST

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 Contact List Management 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 5

Across 5 paths, the API surfaces 5 operations — 1 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Contact List Management 5

Operations for managing contact lists and contacts

POST
/v3/campaign-management/campaigns/{campaignId}/contact-list
Create contact list
createContactList 1 param body → 201400
POST
/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/contacts
Create contacts within a contact list
createContactsInContactList 2 params body → 202400
PATCH
/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/contacts/{contactId}
Update a contact's status within a contact list
updateContactStatusInContactList 3 params body → 202400
PATCH
/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/status
Update contact list status
updateContactListStatus 2 params body → 200400
GET
/v3/campaign-management/campaigns/{campaignId}/contact-lists
Get Contact Lists within a Campaign
getContactListsInCampaign 3 params → 200400

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CreateContactListRequest (3 properties), UpdateContactResponse (3 properties), GetContactListsResponse (3 properties), UpdateContactListStatusResponse (3 properties). Each schema is shown below with its type and property counts.

CreateContactResponse
object
3 properties
GetContactListsResponse
object
Response containing a list of contact lists
3 properties
UpdateContactResponse
object
3 properties
CreateContactListRequest
object
3 properties 1 required
CreateContactRequest
object
1 property
UpdateContactRequest
object
1 property
UpdateContactListStatusRequest
object
1 property
ErrorResponse
object
Error response
2 properties
CreateContactListResponse
object
3 properties
UpdateContactListStatusResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-contact-list-management-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