# Bright Pattern Lists API **Canonical:** https://apis.io/apis/bright-pattern/bright-pattern-lists-api/ **Provider:** Bright Pattern — https://apis.io/providers/bright-pattern/ **Base URL:** https://{tenant}.brightpattern.com/configapi/v2 **Documentation:** https://help.brightpattern.com/latest:Api Bright Pattern Lists API is one of 14 APIs that [Bright Pattern](https://apis.io/providers/bright-pattern/) publishes on the [APIs.io](https://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. 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… ## Machine-readable artifacts (12) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bright-pattern/refs/heads/main/openapi/bright-pattern-lists-api-openapi.yml - **Postman** — https://documenter.getpostman.com/view/6711197/S1EUtanN - **Postman** — https://documenter.getpostman.com/view/8336025/SVYwJbLw - **Postman** — https://documenter.getpostman.com/view/8336025/2sB3WmV3UC - **Postman** — https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z - **Postman** — https://documenter.getpostman.com/view/6735878/T1DtdFDu - **Postman** — https://documenter.getpostman.com/view/31590362/2sA3XTfLhk - **Postman** — https://documenter.getpostman.com/view/6711197/S1ETRbny - **Postman** — https://documenter.getpostman.com/view/6711197/S1EUtb1f - **Postman** — https://documenter.getpostman.com/view/6735878/T1DwbtSk - **Postman** — https://documenter.getpostman.com/view/6735878/TzXwFJFP - **Postman** — https://documenter.getpostman.com/view/6735877/T1LHGpBY ## Other Bright Pattern APIs (12) - [Bright Pattern Authentication API](https://apis.io/apis/bright-pattern/bright-pattern-authentication-api/) - [Bright Pattern Calling List API](https://apis.io/apis/bright-pattern/bright-pattern-calling-list-api/) - [Bright Pattern Campaigns API](https://apis.io/apis/bright-pattern/bright-pattern-campaigns-api/) - [Bright Pattern DNC Lists API](https://apis.io/apis/bright-pattern/bright-pattern-dnc-lists-api/) - [Bright Pattern Do Not Call List API](https://apis.io/apis/bright-pattern/bright-pattern-do-not-call-list-api/) - [Bright Pattern Link Groups API](https://apis.io/apis/bright-pattern/bright-pattern-link-groups-api/) - [Bright Pattern Methods API](https://apis.io/apis/bright-pattern/bright-pattern-methods-api/) - [Bright Pattern Multichannel Call Recordings API](https://apis.io/apis/bright-pattern/bright-pattern-multichannel-call-recordings-api/) - [Bright Pattern Phones API](https://apis.io/apis/bright-pattern/bright-pattern-phones-api/) - [Bright Pattern Regular Call Recordings API](https://apis.io/apis/bright-pattern/bright-pattern-regular-call-recordings-api/) - [Bright Pattern SMS/MMS Messaging API](https://apis.io/apis/bright-pattern/bright-pattern-sms-mms-messaging-api/) - [Bright Pattern Task Routing API](https://apis.io/apis/bright-pattern/bright-pattern-task-routing-api/) ## Tags List --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bright-pattern/bright-pattern-lists-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bright-pattern/.