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

Bright Pattern's List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records.Note: Performing operations on lists requires the user to have the "Manage Lists" privilege, configured in the Contact Center Administrator application. Additional privileges required are explicitly specified in the corresponding method description.All of the methods described below use the path variable, list_id, to specify the list an operation is to be performed on. The unique identifier of a list can be found by opening that list in the Contact Center Administrator application, Lists section. The id will be displayed in the '#LISTS:LISTS_PROPERTIES:' fragment of the URL.Alternatively, list_id, can be found in the response body of the Get Lists method (see here).Methods retained from the previous version of the List management API, tagged as "DEPRECIATED", require an additional path variable, campaign_id, to reference the campaign associated with the selected list. The unique identifier of a campaign can be found by opening that campaign in the Contact Center Administrator application, Services & Campaigns section. The id will be displayed in the '#SERVICES_CAMPAIGNS:SERVICES_PROPERTIES:' fragment of the URL.Alternatively, campaign_id, can be found in the response body of the Get Campaigns method (see here).Note: When importing records or updating records it is important to remember that:All leading and trailing whitespaces should be deleted.For all PHONE numbers:If a number begins with “+”, the leading "+" sign will be removed.If a number contains non-numeric characters, they will be removed.At least one PHONE number is required.For the United States and Canada PHONE numbers:If a number begins with “011”, it will be kept as is.If a number begins with “1” and has eleven digits, it will be kept as is.If a number does not begin with “1” and has ten digits, “1” will be prepended.If a number begins with “1” and has ten digits, the record will not be imported, returning a format error.In any other case, the record will not be imported, returning a format error.Remove prefix and Default country code fields will be ignored.For Other countries PHONE numbers:If a number begins with prefix matching Remove prefix, the prefix will be deleted.If a number does not begin with prefix matching Remove prefix, it will be kept as is.If a number does not begin with prefix matching Default country code, Default country code will be added.For all INTEGER fields:If the value is presented as a string, it should be converted to an integer.Values presented as integers should be supported.For all fields that expect strings (ACCOUNT, AGENT_LOGIN_ID, FIRST_NAME, LAST_NAME, etc.) integer values should be converted to strings.Capitalization matters: values with different capitalizations are treated as distinct.For all DATE/TIME and DATE/TIME - SCHEDULE CALL AT fields:If a…

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

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

19 operations 19 paths 0 schemas 1 DELETE2 GET1 PATCH15 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 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 19

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

Lists 19

Bright Pattern's List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records. Note: Performing operations o…

POST
/configapi/v3/callinglist/getAll/{list_id}/{campaign_id}
Get All Records DEPRECATED
getAllRecordsDeprecated 2 params body → 200
POST
/configapi/v3/callinglist/getChanged/{list_id}/{campaign_id}
Get Updated Records DEPRECATED
getUpdatedRecordsDeprecated 2 params body → 200
POST
/configapi/v3/callinglist/get/{list_id}/{campaign_id}
Query a Record DEPRECATED
queryARecordDeprecated 2 params body → 200
POST
/configapi/v3/callinglist/fetchAll/{list_id}
Fetch All Records
fetchAllRecords 1 param body → 200
POST
/configapi/v3/callinglist/fetch/{list_id}
Fetch Record
fetchRecord 1 param body → 200
POST
/configapi/v3/callinglist/getAll
Get Lists
getLists body → 200
GET
/configapi/v3/callinglist/getList/{list_id}
Get List
getList 1 param → 200
DELETE
/configapi/v3/callinglist/deleteList/{list_id}
Delete List and Orphaned Format
deleteListAndOrphanedFormat 1 param → 200
POST
/configapi/v3/callinglist/createList
Create List
createList body → 200
POST
/configapi/v3/callinglist/createListWithNewFormat
Create List with New Format
createListWithNewFormat body → 200
PATCH
/configapi/v3/callinglist/updateListProperties/{list_id}
Update List Properties
updateListProperties 1 param body → 200
POST
/configapi/v3/callinglist/addAll/{list_id}
Add Many Records
addManyRecords 1 param body → 200
POST
/configapi/v3/callinglist/add/{list_id}
Add Record
addRecord 1 param body → 200
POST
/configapi/v3/callinglist/updateAll/{list_id}
Update Many Records
updateManyRecords 1 param body → 200
POST
/configapi/v3/callinglist/update/{list_id}
Update Record
updateRecord 1 param body → 200
POST
/configapi/v3/callinglist/delete/{list_id}
Delete Many Records
deleteManyRecords 1 param body → 200
POST
/configapi/v3/callinglist/erase/{list_id}
Erase Record
eraseRecord 1 param body → 200
POST
/configapi/v3/callinglist/deleteAll/{list_id}
Delete All Records
deleteAllRecords 1 param → 200
GET
/configapi/v3/job/{job_id}
Get Job Status
getJobStatus 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bright-pattern-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 DNC Lists API
Bright Pattern Do Not Call List API
Bright Pattern Link Groups 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 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.