How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

8x8 External Campaign API

External customer-facing endpoints for campaign management

8x8 External Campaign API is one of 71 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Campaign API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against a single base URL, https://api.8x8.com/cc/{customer-site}/campaigns/v1.

2 operations 2 paths 10 schemas 1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.8x8.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

8x8 External Campaign API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — 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-acc…

Paths & Operations 2

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

External Campaign API 2

External customer-facing endpoints for campaign management

POST
/{campaignId}/records
Add records to campaign
addRecords 3 params body → 400201404500
PATCH
/{campaignId}
Modify campaign state
modifyCampaign 3 params body → 400404500200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Campaign (13 properties), Record (10 properties), ErrorMessage (6 properties), AddRecordRequest (4 properties). Each schema is shown below with its type and property counts.

AddRecordRequest
object
Request to add a single record to a campaign
4 properties 1 required
FieldError
object
Validation error for a specific field
3 properties
StartCampaignRequest
object
Request to start a campaign, optionally triggering a build-then-start sequence
ErrorMessage
object
RFC 9457 Problem JSON error response
6 properties
Campaign
object
Campaign representation with state, timing, and record statistics
13 properties
RecordCount
object
Record count by type, state, and result
4 properties
AddRecordsRequest
object
Records to add (1-100 records)
1 property 1 required
AddRecordsResponse
object
Response containing successfully added records
1 property
Record
object
Campaign record representing a single contact to be dialed
10 properties
ModifyCampaignRequest
object
Request to modify campaign state or properties
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-external-campaign-api-api-openapi.yml Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Event Streaming API
Jitsi as a Service (JaaS)
8x8 CPaaS Voice Webhooks
8x8 Addresses API
8x8 Agent Activity API
8x8 Agent status API
8x8 Agents API
8x8 Analytics API
8x8 Attachments API
8x8 Audit API
8x8 Authentication API
8x8 Batch API
Where this information came from

This is an independent, third-party profile of 8x8 External Campaign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.