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…

Business capability
Contact Centre Operations Management BC-430.30

Operations 19

POST /configapi/v3/callinglist/getAll/{list_id}/{campaign_id} Get All Records DEPRECATED #
POST /configapi/v3/callinglist/getChanged/{list_id}/{campaign_id} Get Updated Records DEPRECATED #
POST /configapi/v3/callinglist/get/{list_id}/{campaign_id} Query a Record DEPRECATED #
POST /configapi/v3/callinglist/fetchAll/{list_id} Fetch All Records #
POST /configapi/v3/callinglist/fetch/{list_id} Fetch Record #
POST /configapi/v3/callinglist/getAll Get Lists #
GET /configapi/v3/callinglist/getList/{list_id} Get List #
DELETE /configapi/v3/callinglist/deleteList/{list_id} Delete List and Orphaned Format #
POST /configapi/v3/callinglist/createList Create List #
POST /configapi/v3/callinglist/createListWithNewFormat Create List with New Format #
PATCH /configapi/v3/callinglist/updateListProperties/{list_id} Update List Properties #
POST /configapi/v3/callinglist/addAll/{list_id} Add Many Records #
POST /configapi/v3/callinglist/add/{list_id} Add Record #
POST /configapi/v3/callinglist/updateAll/{list_id} Update Many Records #
POST /configapi/v3/callinglist/update/{list_id} Update Record #
POST /configapi/v3/callinglist/delete/{list_id} Delete Many Records #
POST /configapi/v3/callinglist/erase/{list_id} Erase Record #
POST /configapi/v3/callinglist/deleteAll/{list_id} Delete All Records #
GET /configapi/v3/job/{job_id} Get Job Status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/bright-pattern-lists-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bright-pattern-lists-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Bright Pattern Lists API
  version: 1.0.0
  contact:
    name: Bright Pattern
    url: https://www.brightpattern.com/contact/
  x-refined-note:
  - x-evidence differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  description: 'Operations tagged Lists across 2 of this provider''s published API definitions: bright-pattern-list-management-v3-2-openapi.yml, bright-pattern-list-management-v3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant_url}
  description: Bright Pattern is multi-tenant; the base host is the customer contact-center tenant domain.
  variables:
    tenant_url:
      default: example.brightpattern.com
      description: Your Bright Pattern Contact Center tenant hostname.
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bright-pattern/refs/heads/main/openapi/bright-pattern-lists-api-openapi.yml