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 DNC Lists API

Bright Pattern's List Management API makes it easy to manage the contents of Do Not Call (DNC) lists with bulk delete, add, and replace actions. The API methods described in this section fully support Internal, Geographic (Postal), Geographic (Area codes), and Record Exclusion DNC list types. Geographic (State/Province) DNC List type is not supported in the current implementation.Note: Performing operations on DNC lists requires the user to have the "Manage Lists" privilege, configured in the Contact Center Administrator application.The functionality of the API methods described in this section is built upon a DNC List Record JSON Object with a required non-empty key field and an optional comment field. Depending on the DNC list type, the object's field values vary as follows:DNC List TypeField ValuesInternalkey (required field): Phone number comment (optional field): Campaign NameGeographic (Postal)key (required field): Postal Code comment (optional field): NotesGeographic (Area Codes)key (required field): Area code comment (optional field): NotesRecord Exclusionkey (required field): Exclusion field comment (optional field): -Note: When importing records or updating records it is important to remember that:All leading and trailing whitespaces should be deleted.All integer values should be converted to strings.Capitalization matters: values with different capitalizations are treated as distinct.The search can be performed by both the original values created in third-party systems and their transformed equivalents visible in the Administrator Application and Agent Desktop.

Bright Pattern DNC Lists 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 DNC Lists. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 13 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}.

13 operations 13 paths 0 schemas 1 DELETE3 GET1 PATCH8 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 DNC Lists 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 13

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

DNC Lists 13

Bright Pattern's List Management API makes it easy to manage the contents of Do Not Call (DNC) lists with bulk delete, add, and replace actions. The API methods described in this…

POST
/configapi/v3/donotcalllist/deleteAll/{do_not_call_list_id}
Delete All Records
deleteAllRecordsDNCLists 1 param → 200
POST
/configapi/v3/donotcalllist/delete/{do_not_call_list_id}
Delete Many Records
deleteManyRecordsDNCLists 1 param body → 200
POST
/configapi/v3/donotcalllist/addAll/{do_not_call_list_id}
Add Many Records
addManyRecordsDNCLists 1 param body → 200
POST
/configapi/v3/donotcalllist/add/{do_not_call_list_id}
Add Records DEPRECATED
addRecordsDeprecated 1 param body → 200
POST
/configapi/v3/donotcalllist/replaceAll/{do_not_call_list_id}
Replace Records DEPRECATED
replaceRecordsDeprecated 1 param body → 200
GET
/configapi/v3/donotcalllist/getDNCRecords/{do_not_call_list_id}
Get DNC Records
getDncRecords 1 param → 200
GET
/configapi/v3/donotcalllist/getAll
Get DNC Lists
getDncLists → 200
GET
/configapi/v3/donotcalllist/getDNCList/{do_not_call_list_id}
Get DNC List
getDncList 1 param → 200
POST
/configapi/v3/donotcalllist/createDNCList
Create DNC List
createDncList body → 200
DELETE
/configapi/v3/donotcalllist/deleteDNCList/{do_not_call_list_id}
Delete DNC List
deleteDncList 1 param → 200
POST
/configapi/v3/campaign/bindDNCList/{campaign_id}
Bind DNC List
bindDncList 1 param body → 200
POST
/configapi/v3/campaign/unbindDNCList/{campaign_id}
Unbind DNC List
unbindDncList 1 param body → 200
PATCH
/configapi/v3/donotcalllist/updateDNCProperties/{do_not_call_list_id}
Update DNC List Properties
updateDncListProperties 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bright-pattern-dnc-lists-api-openapi.yml Raw ↑

Other APIs Bright Pattern publishes across the network.

Bright Pattern Authentication API
Bright Pattern Calling List API
Bright Pattern Campaigns 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 DNC Lists 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.