Bright Pattern's List Management API supports a wide range of functionalities previously only accessible within the Contact Center Administrator application. Version 3.1 delivers expanded list and campaign management functionality, introducing comprehensive API support for Do Not Call (DNC) lists and improved methods for accessing Calling List records.
\nBright Pattern's List Management API 3.1 enables you to:
\nManage outbound campaigns, including their DNC list (new*) and calling list associations
\nUpdate outbound campaign states, access their information, and view their results
\nCreate new lists and new formats
\nView and update (new*) calling list properties
\nManage calling list and DNC list records individually or in bulk
\nRetrieve the contents of Calling Lists not associated with campaigns (new*)
\nCreate, retrieve, update, and delete DNC lists (new*)
\nNote: To ensure compatibility with the last API version and facilitate seamless migration, all previously available methods are retained as is. However, methods with a \"DEPRECIATED\" tag in their name are not recommended for usage and have new corresponding methods defined for their respective functionalities.
\nThis document describes the available REST API methods, specifies their functionality, and provides example requests and responses. Individual methods, as well as the entire List Management API 3.1 collection, can be loaded into Postman and interacted with via your unique Bright Pattern Contact Center access token.
\nnew* - added since List API 3.0
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8336025","collectionId":"a1a4ec8f-9e25-46b5-8b29-46143da47c3a","publishedId":"2sB3WmV3UC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-29T02:43:41.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","id":"d62af794-1c58-4d8e-acb2-eb8fc197b22a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"Username ","type":"text"},{"key":"client_secret","value":"API secret","type":"text"},{"key":"scope","value":"This method returns an access token that will be used to authenticate each subsequent request made via this API.
\nNote: Access Tokens expire after 1 hour and require renewal.
\nSupplementing invalid credentials in any of the parameters will return a 401 Authentification failed response. Client authentification will also fail if the selected user is locked out or disabled, or the chosen tenant is inactive.
Note: Clients are authenticated using OAuth 2.0 Client Credentials Grant, therefore, thegrant_type parameter is always set to 'client_credentials'. Examples of other parameter values can be found in the Request body below.
The authentification method described in this section is the first step required to successfully use Bright Pattern's List Management API. The clients of this API are authenticated in correspondence with the OAuth 2.0 Client Credentials Grant. Requests made via this API are authenticated via an access token.
\nNote: Only the users with corresponding privileges can perform selected operations via this API. The complete list of privileges can be found here.
\nTo obtain the access token:
\nThis method returns a list of enabled outbound campaigns, their current states, and unique identifiers. Based on the user privileges configured, the list will contain all campaigns or only those assigned to this user (see here). An empty list will be returned if no outbound campaign is currently enabled or the user has no assigned campaigns.
\nNote: A campaign's unique identifier returned in the response body can be used to reference that campaign in the path variables of further API requests.
\nThis method returns the current state, i.e. STOPPED or RUNNING, of an enabled or disabled campaign, as well as its associated calling and Do Not Call (DNC) lists.
\nNote: List and DNC list unique identifiers returned in the response body can be used to reference these lists in further API requests.
\nNote: Bright Pattern Contact Center solution supports several DNC list types - Internal, Geographic (Postal), Geographic (State/Province), Geographic (Area codes), and Record Exclusion (see here). These list types have respective values in the response body: INTERNAL, GEOGRAPHIC_POSTAL, GEOGRAPHIC_STATE, GEOGRAPHIC_AREACODE, EXCLUSION.
This method returns the current state, i.e. STOPPED or RUNNING, of an enabled or disabled campaign.
\nThis method starts an enabled campaign, first checking that the campaign is not disabled or already running.
\nNote: Manipulating campaign states requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nThis method stops an enabled campaign, first checking that the campaign is not disabled or already stopped.
\nNote: Manipulating campaign states requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nThis method adds a list to the selected campaign.
\nOnce added, an instance of the list associated with this particular campaign is created. The ID of such an instance is returned in the response body, together with the total number of records inside the original list.
\nNote: The instance's unique identifier can be further used to unbind or update the list, get campaign results, or query a record from that list.
\nNote: Manipulating calling lists associated with a campaign requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nThis method changes the properties of an instance of a list in the associated campaign. The instance is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method (see here). Additionally, this method can reset an optional parameter to its default value by passing \" \" or null to that parameter.
Before the list is updated, its binding to the specified campaign is checked. If the instance is bound to the specified campaign, the list is updated successfully.
\nNote: Manipulating the content of calling lists associated with a campaign requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nThis method removes the instance of a list from the associated campaign. The instance to be removed is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method (see here).
Note: Bright Pattern Contact Center solution supports several voice campaign modes (see here). Depending on the mode of the associated campaign, the active call behavior will differentiate as follows:
\nThe results of completed calls are archived and available for downloading in the Contact Center Administrator application (see here). Interaction results for dropped calls are not saved.
\nThis method returns a list of all records in an instance. The instance is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method (see here). Optionally, this method can also display request attempts made. The records are returned and sorted by the standard MongoDB _id field.
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id field is used as the \"cursor\" to reference the last served record.
This method returns a list of all completed records within an instance. The instance is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method (see here). Optionally, the user can view request attempts and specify the completion time frame for which they want to display the completed records list. The records are returned and sorted by completion time (MongoDB completedTime field).
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id and the completedTimefields are concatenated and used as the \"cursor\" to reference the last served record.
Note: The input parameters defined for this method in the List Management API 3.0 differ from the previous version.
\nThis method returns a list of all updated records within an instance. The instance is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method. Optionally, the user can view request attempts and specify the time frame for which they want to display the updated records list. The records are returned and sorted by the last date attempted (MongoDB lastDate field).
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id and the lastDatefields are concatenated and used as the \"cursor\" to reference the last served record.
Note: The input parameters defined for this method in the List Management API 3.0 differ from the previous version.
\nThis method returns a copy of an existing record in an instance, as well as the information about the last interaction associated with this record. The instance is specified by its unique identifier, instanceID, returned in the response body of the Get Campaign method (see here). The search for the record is performed based on the defined key fields.
Before the record is queried, its existence in the specified list is checked. If the record does exist in the specified list, the record is queried successfully.
\nNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).
\nNote: The response body contains the List Record JSON Object, defined by two sub-objects as follows:
\nentry object: contains a copy of the list entrycustom_' added to the name defined in the Administrator Applicationstatusobject: contains the campaign results for this specific recordBright Pattern's List Management API provides a convenient way to perform routine campaign management tasks without the Contact Center Administrator application. The API methods described in this section allow managers to manipulate campaign activity, view campaign data, and perform actions on associated calling lists.
\nBright Pattern Contact Center solution defines several outbound campaign types - Outbound Voice, Blended Voice, and Outbound Messaging. The API methods described in this and the following sections fully support each campaign type.
\nNote: Performing operations on all campaigns requires the user to have the \"Manage all services and campaigns\" privilege, configured in the Contact Center Administrator application. Alternatively, the \"Manage assigned services and campaigns\" privilege must be enabled for users to manipulate only their assigned campaigns. Additional privileges required are explicitly specified in the corresponding method descriptions.
\nThe methods described below use the path variable, campaign_id, to reference the campaign an operation is to be performed on. 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).
This method returns a list of records from a calling list associated with a campaign.
\nRecords are referenced by indexes, assigned to each record in the list in sequential order of insertion (beginning from 0). All records with an index greater than or equal to the requested record index, fromIndex, are returned in the response.
Note: The returned recordset contains JSON objects sorted by the index field. List Record JSON Object has two sub-objects, entry and status, defined as follows:
\nentry object: contains a copy of the list entry
field names are retained as defined at list creation
\n![Services & Campaigns section](\"https://help.brightpattern.com/File:CCA-Services-and-Campaigns-Overview-53.PNG\"){kind=link}
custom_' added to the name defined in the Administrator ApplicationNote: The value returned in the id field can be used to reference this record in further API requests.
\nstatusobject: contains the campaign results for this specific record
omitted if the list is not assigned to the campaign or the campaign doesn't exist
\nfield names are predefined
\ncompleted field is always present, while the other fields may be absent if the record was never called or never reached an agent.
\nThis method returns a list of records from a calling list that have had any activity within the associated campaign since the requested initial time, fromTime.
Note: The returned record set contains JSON objects sorted by the index field. List Record JSON Object has two sub-objects, entry and status, defined as follows:
\nentry object: contains a copy of the list entry
field names are retained as defined at list creation
\ncustom_' added to the name defined in the Administrator Applicationtime and date field values are returned in UTC format
\nstatusobject: contains the campaign results for this specific record
omitted if the list is not assigned to the campaign or the campaign doesn't exist
\nfield names are predefined
\ncompleted field is always present, while the other fields may be absent if the record was never called or never reached an agent.
\nThis method returns a copy of an existing record in a calling list of an associated campaign. The list is specified in the path variable, list_id, by its unique identifier returned in the response body of the Get Campaign method (see here). The campaign is specified in the path variable, campaign_id, by its unique identifier returned in the response body of the Get Campaigns method (see here).
The record search is performed by its unique identifier, id, returned in the response body of the Get All Records method (see here). If the list has been added to the specified campaign more than once, the method returns an array of records. An error is returned if a record with the specified id does not exist in the selected list.
Note: The response body contains the List Record JSON Object, defined by two sub-objects as follows:
\nentry object: contains a copy of the list entrycustom_' added to the name defined in the Administrator Applicationstatusobject: contains the campaign results for this specific recordNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).
\nThis method returns a list of records from an existing calling list, specified in the path variable, list_id.
\nRecords are referenced by indexes, assigned to each record in the list in sequential order of insertion (beginning from 0). All records with an index greater than or equal to the requested record index, fromIndex, are returned in the response.
Note: The returned recordset contains JSON objects sorted by the index field. List Record JSON Object contains:
\nentry object: contains a copy of the list entry
field names are retained as defined at list creation
\nNote: The value returned in the id field can be used to reference this record in further API requests.
\nThis method returns a copy of one or more existing records in a calling list. The search for the records is performed based on the defined key fields.
\nNote: Time and date field values are returned in UTC format.
\nNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).
\nThis method returns all Calling Lists, sorted by the standard MongoDB _id field.
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id field is used as the \"cursor\" to reference the last served record.
This method returns the information about a list, including its name, the format name, timezone settings, and amount of records of the specified list. Additionally, it returns the information about the associated campaign of that list, if any.
\nThis method deletes a list, archiving all records with associated campaign results associated with that list. If the last list using a specific format was deleted, that format is removed as well.
\nNote: Bright Pattern Contact Center solution supports several voice campaign modes (see here). Depending on the mode of the associated campaign, the active call behavior will differentiate as follows:
\nThe results of completed calls are archived and available for downloading in the Contact Center Administrator application (see here). Interaction results for dropped calls are not saved.
\nThis method creates a new empty list using an existing format. The format is specified by its unique identifier, formatId, returned in the response body of the Get Lists method (see here).
This method creates a new empty list and a new format corresponding to that list.
\nWhen creating the new list format, the fields must be defined with the following properties in mind:
\nNote: The following properties are not used when the method is called: CUSTOM_DELIMITER(default 'COMMA' value is set), DEFAULT_ENCODING(default 'UTF-8' value is set), DELIMITER_TYPE, FORMAT_TYPE(default 'DELIMITED' value is set),NAMES_IN_FIRST_LINE, SOURCE_TYPE.
This method allows to change the name and the expiration settings of an existing calling list, specified in the path variable, list_id.
\nThis method updates fields in existing records of a calling list and returns the number of successfully updated records.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nThis method catches and displays the following errors (if any were encountered during the request execution):
\nlimitExceeded - the maximum total number of rows across all existing lists has been reachedmissingKey - one or more key field values were not found;duplicateKey - a record with the same key already exists in the list;missingRequired - one or more required fields are missing values;formatError - format was mismatched in one or more field values (e.g. string value was defined for an integer field); one or more unsupported fields were defined in the request bodyThis method adds a single new record to a calling list.
\nBefore the record is added, the uniqueness of its key values is checked against the contents of the list. If the list does not already have a record with the specified key values, the new record is added successfully.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nThis method updates fields in existing records of a calling list and returns the number of successfully updated records. Additionally, this method can reset optional parameters to their default values by passing \" \" or null to these parameters.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nThis method catches and displays the following errors (if any were encountered during the request execution):
\nmissingKey - one or more key field values were not found;keyNotFound - a record with the same key already exists in the DNC list;formatError - format was mismatched in one or more field values (e.g. string value was defined for an integer field); one or more unsupported fields were defined in the request bodyNote: This method is similar to the Update Record method. However, the input parameters differ to accommodate updating multiple records within one request. This is done to account for the fact that each request requires reprocessing of the entire calling list.
\nThis method updates fields in an existing record of a calling list. Additionally, this method can reset an optional parameter to its default value by passing \" \" or null to that parameter.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nThe search for the record is performed based on the defined key fields. The request can contain either a full or partial set of fields of the List Record JSON Object, but the key fields are mandatory and must be retained as configured during list creation.
\nBefore the record is queried, its existence in the specified list is checked by its unique key values. If the record does exist in the specified list, the record is updated successfully.
\nNote: If a PHONE type field is defined as a key, the record value is checked for a full match with the value stored in the database or the original source (if the data was modified upon loading into the database).
\nTo avoid disruptions in the campaign work caused by the list reprocessing time, the Dialer ignores the changes made to the record until it makes a call attempt to that record. Thus, if a list containing the updated record has Filters or Sorting configured, the changes made to that record will not affect that filtering or sorting order.
\nNote: Always remember to reapply the desired Filters or Sorting settings if you wish for it to reflect the changes made to the updated record.
\nThis method deletes records from a list and returns the number of successfully deleted records.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nRecords are searched for by one or many criteria defined in correspondence with the associated list fields. At least one of the available filtering criteria has to be specified. Otherwise, no record is deleted.
\nThe method supports filtering records by:
\nfields.some_field parameter);byCampaignResult.policy parameter);createdFrom and createdTo parameters);Note: Filtered records will be deleted from all campaigns the list is associated with.
\nThis method removes a record from a list and all associated campaign results. The search for the record is performed based on the defined key fields. An error is returned if a record does not exist.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nBright Pattern Contact Center solution supports several voice campaign modes (see here). If the last record is being deleted, depending on the mode of the associated campaign, the active call behavior will differentiate as follows:
\nOtherwise, if there are still other records in the list, the method won't impact any calls.
\nThe list of deleted records with completed calls, as well as their results, are archived and available for downloading in the Contact Center Administrator application (see here). Interaction results for dropped calls are not saved.
\nNote: This method does not delete contacts, activities, voice recordings, transcriptions, or screen recordings. This functionality is covered by other APIs.
\nThis method removes all records from a list and returns the number of successfully deleted records.
\nNote: Manipulating the content of calling lists requires the user to have an additional \"Update content of calling list\" privilege.
\nBright Pattern Contact Center solution supports several voice campaign modes (see here). Depending on the mode of the associated campaign, the active call behavior will differentiate as follows:
\nThe list of deleted records with completed calls, as well as their results, are archived and available for downloading in the Contact Center Administrator application (see here). Interaction results for dropped calls are not saved.
\nBright Pattern's List Management API streamlines the creation and deletion of lists and formats and provides a convenient way to manage list records.
\nNote: 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.
\nAll 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:
\nAll leading and trailing whitespaces should be deleted.
\nFor all PHONE numbers:
\nIf a number begins with “+”, the leading \"+\" sign will be removed.
\nIf a number contains non-numeric characters, they will be removed.
\nAt least one PHONE number is required.
\nFor the United States and Canada PHONE numbers:
\nIf a number begins with “011”, it will be kept as is.
\nIf a number begins with “1” and has eleven digits, it will be kept as is.
\nIf a number does not begin with “1” and has ten digits, “1” will be prepended.
\nIf a number begins with “1” and has ten digits, the record will not be imported, returning a format error.
\nIn any other case, the record will not be imported, returning a format error.
\nRemove prefix and Default country code fields will be ignored.
\nFor Other countries PHONE numbers:
\nIf a number begins with prefix matching Remove prefix, the prefix will be deleted.
\nIf a number does not begin with prefix matching Remove prefix, it will be kept as is.
\nIf a number does not begin with prefix matching Default country code, Default country code will be added.
\nFor all INTEGER fields:
\nIf the value is presented as a string, it should be converted to an integer.
\nValues presented as integers should be supported.
\nFor all fields that expect strings (ACCOUNT, AGENT_LOGIN_ID, FIRST_NAME, LAST_NAME, etc.) integer values should be converted to strings.
\nCapitalization matters: values with different capitalizations are treated as distinct.
\nFor all DATE/TIME and DATE/TIME - SCHEDULE CALL AT fields:
\nThe 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.
\nPrivileges required:
\nThis method deletes all records from the specified DNC List and returns the number of deleted records.
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","deleteAll",":do_not_call_list_id"],"host":["Privileges required:
\nThis method deletes the list of specified records from the DNC List, returns the number of deleted records and list of errors if there are.
\nThe following errors should be caught:
\nInput parameters: list of DNC list record JSON objects, only key field is required.
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","delete",":do_not_call_list_id"],"host":["Privileges required:
\nThis method adds new records to the specified Do Not Call (DNC) list and returns the number of added (i.e., appended) records. Duplicates are ignored.
\nThe following errors should be caught:
\nInput parameters: list of DNC list record JSON objects.
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","addAll",":do_not_call_list_id"],"host":["Privileges required:
\nThis method adds new records to the specified Do Not Call (DNC) list and returns the number of added (i.e., appended) records. Duplicates are ignored.
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","add",":do_not_call_list_id"],"host":["Privileges required:
\nThe method deletes all records in the specified Do Not Call (DNC) list, inserts new ones and returns the number of newly inserted records. Duplicates are ignored.
\nResponse Codes:
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","replaceAll",":do_not_call_list_id"],"host":["This method returns a list of all records, including their in an existing DNC List, specified in the path variable, do_not_call_list_id. The records are returned and sorted by the standard MongoDB _id field.
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id field is used as the \"cursor\" to reference the last served record.
This method returns all DNC Lists, sorted by the standard MongoDB _id field.
Note: To accommodate the display of large numbers of list records, Bright Pattern Contact Solution utilizes Cursor-based pagination (see here). The _id field is used as the \"cursor\" to reference the last served record.
This method returns the detailed information about a specified DNC list, including it's name, type and total number of records, as well as exipartion and reset settings, if applicable.
\nAdditionally, this method returns information about the campaigns associated with that DNC list, if any.
\nThis method creates a new empty DNC list. Depending on the specified DNC list type, the creation process is as follows:
\nFor Internal, Geographic, Area Codes - new DNC lists are created using the fixed format corresponding to the list type
\nFor Record Exclusion - the exclusion field has to be explicitly specified in the request body
\nAdditionally, for DNC lists of Area Codes and Geographic Postal types, the ISO country code has to be explicitly specified in the request body.
\nNote: For Area Codes, additional option “Each area code had country prefix” is available. This option can be specified using “Prefixed” as the country value.
\nOn succesfull excution, the response should contain the ID of the newly created DNC list.
\nThis method allows to change properties and settings of an existing DNC list, specified in the path variable, do_not_call_list_id.
\nThis method deletes the DNC list specified in the path variable, do_not_call_list_id.
\nOnce the DNC List is deleted, all records previously blocked by it in the associated campaign(s) become dialable again.
\nNote: Archivation of DNC Lists and DNS List records is not supported in the Admin Portal, so no special considerations should be made for List API.
\n","urlObject":{"protocol":"https","path":["configapi","v3","donotcalllist","deleteDNCList",":do_not_call_list_id"],"host":["This method adds a DNC list to the campaign, referenced by its ID in the path variable.
\nNote: Manipulating calling lists associated with a campaign requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nThis method removes the DNC list from the associated campaign, referenced by its ID in the path variable., campaign_id.
\nThe DNC list to be removed is specified in the request body by its unique identifier, dncListId.
\nNote: Manipulating calling lists associated with a campaign requires the user to have an additional \"Start campaigns and enable lists\" privilege.
\nBright 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.
\nNote: Performing operations on DNC lists requires the user to have the \"Manage Lists\" privilege, configured in the Contact Center Administrator application.
\nThe 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:
\nNote: When importing records or updating records it is important to remember that:
\nCursor-based Pagination, utilized in many of the Bright Pattern's List Management API methods is a current state-of-the-art approach to dealing with large volumes of data.
\nIn cases where API requests are expected to contain many and many rows of records, returning them all at once is not an option. Instead, it makes sense to return one subset of a predefined size, a page, at a time. This technique, called paging, is commonly used across the majority of APIs. The cursor-based part of our approach comes from the idea of using a \"cursor\" - something like a bookmark that points exactly to where you left off.
\nAt the core of Cursor-based pagination lies a rather basic concept of pointers. The pointer in this case is called a \"cursor\", and is used to reference a specific record in a database. In each request, clients pass cursor along with page_size parameter that specifies the number of records returned per page.
It is important to remember that:
\n![Lists section](\"https://help.brightpattern.com/File:CCA-Lists-Properties-54.PNG\"){kind=link}
cursor must refer to a specific unique value in the database.cursor value is not provided, the first record in the database will be used by default.page_size , with corresponding field values less than the value of cursor are returned.page_size, it implies that there are no more records and the page returned was the last one.page_size + 1 is passed back to the client as the next_cursor.Note: This section provides general information regarding unsuccessful execution responses. We recommend you refer to the Response Codes description provided for each method individually for more specific information about any encountered errors.
\nBright Pattern’s List Management API utilizes standard HTTP codes to indicate successful execution and flag errors if any occur. For each error listed in this documentation, the response includes the following information:
\nHuman-readable error name - e.g. \"bad_request\"
Detailed description of what caused the error to occur - e.g. \"'parameter_name' has unsupported value 'parameter_value': integer is expected\"
and has the following format:
\n{ \n “error”: “name”, //error name\n “error_description”: “description” //detailed description of the reasons that led to this error\n}\n\nNote: We highly recommend paying close attention to the content of error_description as it offers useful information to aid debugging.
The table below contains the full list of HTTP errors and specifies possible underlying reasons for each of them.
\n","_postman_id":"ed3b3b04-32bf-4ddf-9e2a-67cdc550816c"}]}