Skip to main content
Version: 1.0.0

Contact Center Campaigns API

Use the Campaign Management API to control the lifecycle of outbound campaigns and dynamically inject records for dialling from your own systems.

Prerequisites​

The campaign must be configured as a Dynamic Campaign in Configuration Manager before records can be added via the API. However, campaign state can be changed via this API for both regular and dynamic campaigns.

Authentication​

All requests require two headers obtained from Admin Console and Configuration Manager:

HeaderDescription
x-api-keyThe Key value from your API app in Admin Console (admin.8x8.com/api-access)
X-8x8-TenantThe Tenant Name from Home > Profile in Configuration Manager

Content Type​

All requests must include the header Content-Type: application/vnd.campaigns.v1+json.

Customer Site​

The {customer-site} path parameter is your site identifier

Authentication​

Admin Console API Key with the Contact Center Campaigns API Product attached to the app. The key value is the Key field from your app at admin.8x8.com/api-access and always starts with eght_.

Security Scheme Type:

apiKey

Header parameter name:

x-api-key

Contact

8x8 Support:

URL: https://support.8x8.com