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

Bright Pattern Campaigns API

The Campaigns API from Bright Pattern — 27 operation(s) for campaigns.

Bright Pattern Campaigns API is one of 14 APIs that Bright Pattern publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 27 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant_url}.

27 operations 27 paths 0 schemas 1 DELETE4 GET4 PATCH18 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://{tenant}.brightpattern.com/configapi/v2
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bright Pattern Campaigns API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token issued by the Bright Pattern token endpoint, sent as Authorization: Bearer .
  • oauth2ClientCredentials — OAuth 2.0 client-credentials grant against the Bright Pattern tenant token endpoint.

Paths & Operations 27

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

Campaigns 27
GET
/configapi/v2/campaign/getAll
Get Campaigns
getCampaigns → 200
GET
/configapi/v3/campaign/getCampaign/{campaign_id}
Get Campaign
getCampaign 2 params → 200
GET
/configapi/v3/campaign/getAll
Get Campaigns
getCampaigns → 200
GET
/configapi/v3/campaign/getStatus/{campaign_id}
Get Campaign Status
getCampaignStatus 1 param → 404
POST
/configapi/v3/campaign/start/{campaign_id}
Start
start 1 param → 200
POST
/configapi/v3/campaign/stop/{campaign_id}
Stop
stop 1 param → 200
POST
/configapi/v3/campaign/bindList/{campaign_id}
Bind List
bindList 1 param body → 200
PATCH
/configapi/v3/campaign/updateList/{campaign_id}
Update List
updateList 1 param body → 200
POST
/configapi/v3/campaign/unbindList/{campaign_id}
Unbind List
unbindList 1 param body → 200
POST
/configapi/v3/campaign/getAllRecords/{campaign_id}
Get All Records
getAllRecords 1 param body → 200
POST
/configapi/v3/campaign/getCompletedRecords/{campaign_id}
Get Completed Records
getCompletedRecords 1 param body → 200
POST
/configapi/v3/campaign/getUpdatedRecords/{campaign_id}
Get Updated Records
getUpdatedRecords 1 param body → 200
POST
/configapi/v3/campaign/queryRecord/{campaign_id}
Query a Record
queryARecord 1 param body → 200
DELETE
/configapi/v3/campaign/deleteCampaign/{campaign_id}
Delete Campaign
deleteCampaign 1 param → 200
POST
/configapi/v3/campaign/unlinkCampaign/{campaign_id}
Unlink a Campaign
unlinkACampaign 1 param → 200
POST
/configapi/v3/campaign/linkCampaign/{campaign_id}
Link a Campaign
linkACampaign 1 param body → 200
PATCH
/configapi/v3/campaign/updateDisposition/{campaign_id}
Update Disposition
updateDisposition 1 param body → 200
POST
/configapi/v3/campaign/deleteDispositions/{campaign_id}
Delete Dispositions
deleteDispositions 1 param body → 200
POST
/configapi/v3/campaign/addDisposition/{campaign_id}
Add Disposition
addDisposition 1 param body → 200
POST
/configapi/v3/campaign/addDispositions/{campaign_id}
Add Dispositions
addDispositions 1 param body → 200
POST
/configapi/v3/campaign/unassignCallerIds/{campaign_id}
Unassign Caller IDs
unassignCallerIds 1 param body → 200
POST
/configapi/v3/campaign/assignCallerIds/{campaign_id}
Assign Caller IDs
assignCallerIds 1 param body → 200
POST
/configapi/v3/campaign/unassignTeams/{campaign_id}
Unassign Teams
unassignTeams 1 param body → 200
POST
/configapi/v3/campaign/assignTeams/{campaign_id}
Assign Teams
assignTeams 1 param body → 200
PATCH
/configapi/v3/campaign/updateCallerIDSettings/{campaign_id}
Update Caller ID Settings
updateCallerIdSettings 1 param body → 200
PATCH
/configapi/v3/campaign/updateGeneralSettings/{campaign_id}
Update General and Outbound Settings
updateGeneralAndOutboundSettings 1 param body → 200
POST
/configapi/v3/campaign/duplicateCampaign
Duplicate Campaign
duplicateCampaign body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bright-pattern-campaigns-api-openapi.yml Raw ↑

Other APIs Bright Pattern publishes across the network.

Bright Pattern Authentication API
Bright Pattern Calling List API
Bright Pattern DNC Lists API
Bright Pattern Do Not Call List API
Bright Pattern Link Groups API
Bright Pattern Lists API
Bright Pattern Methods API
Bright Pattern Multichannel Call Recordings API
Bright Pattern Phones API
Bright Pattern Regular Call Recordings API
Bright Pattern SMS/MMS Messaging API
Bright Pattern Task Routing API
Where this information came from

This is an independent, third-party profile of Bright Pattern Campaigns 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.