With the BPCC List Management API you currently can:
\nThis document specifies the corresponding REST API methods, with example requests and responses. You can load this API into the Postman API Development Environment to interact with the API with your own access tokens.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"}],"owner":"6735878","collectionId":"03b8e6ea-0ddb-4364-abf8-1336a8c20e4d","publishedId":"T1DtdFDu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-29T16:15:22.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","id":"62eec3fc-574b-4b4b-b39f-dbb3f354b8fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","description":"Username of a Bright Pattern user authorized to manage users and manage all teams
\n","type":"text"},{"key":"client_secret","value":"","description":"API secret key generated for the above user
\n","type":"text"},{"key":"scope","value":"","description":"Your contact center URL (e.g., yourcompany.brightpattern.com)
\n","type":"text"},{"key":"grant_type","value":"","description":"Grant type; must be set to client_credentials
\n","type":"text"}]},"url":"https://Returns an access token that will be used to authenticate each subsequent request made via this API.
\n","urlObject":{"protocol":"https","path":["configapi","v2","oauth","token"],"host":["The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found here. Privileges are assigned to users via one or more roles.
\nTo obtain an access token:
\nThis method adds multiple new records to the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition already exists.
\nNotes:
\nThis method adds a single new record to the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition already exists.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"544ae1a1-d99a-44a4-b4fa-deccf414c6ac","name":"Add Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"4\",\r\n \"firstName\": \"Post\",\r\n \"lastName\": \"Melon\",\r\n \"Phone\": \"16505555555\",\r\n \"Status\": \"Platinum\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/add/:list_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","add",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a42acd99-1f50-41f4-823b-8d65e078ef31"},{"name":"Delete All Records","id":"0d2dbc2b-c9ca-406e-a528-7994b6db8554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method deletes all records from the calling list. List results are also deleted. It returns OK if the list exists but is empty already. Note that this method erases calling list results and it will do so regardless of whether the results have been exported or not.
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"a6ad46d1-e580-4101-a004-1721c8008f74","name":"Delete All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/deleteAll/:list_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","deleteAll",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0d2dbc2b-c9ca-406e-a528-7994b6db8554"},{"name":"Get All Records","id":"343ed3d3-c164-4eb5-bb88-80e252abee12","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerCalling list records are sequentially numbered in order of insertion, beginning from zero. This method returns a list of records in the calling list that has an index that is greater than or to equal to the requested record index.
\nInput parameters are \"initial record index\" and \"maximum size of returned list.\" Current implementation limits \"maxSize\" to 1000 records. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"961cf954-49e7-4810-8dd1-55090e92196d","name":"Get All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromIndex\": 0,\r\n \"maxSize\": \"100\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/getAll/:list_name/:campaign_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","getAll",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"entry\": {\n \"firstname\": \"Graham\",\n \"phone\": \"16509999999\",\n \"id\": \"1\",\n \"lastname\": \"Smith\",\n \"status\": \"Gold\"\n },\n \"index\": 0,\n \"status\": {\n \"globalInteractionID\": \"0B767156-D012-4F63-A3E2-12ACFC2F26EA\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"No disposition\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16509999999\",\n \"lastDate\": \"2021-02-19T19:11:40.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16507777777\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"index\": 1,\n \"status\": {\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Try again later\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16507777777\",\n \"lastDate\": \"2021-02-19T19:12:21.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16505555555\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"index\": 2,\n \"status\": {\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Product sold\",\n \"totalAttempts\": 1,\n \"completed\": true,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16505555555\",\n \"lastDate\": \"2021-02-19T19:12:37.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Jenny\",\n \"phone\": \"16502222222\",\n \"id\": \"4\",\n \"lastname\": \"Green\",\n \"status\": \"Gold\"\n },\n \"index\": 3,\n \"status\": {\n \"globalInteractionID\": \"35DE77AC-5A37-4907-97CA-50B09B30ECDF\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Fast busy\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16502222222\",\n \"lastDate\": \"2021-02-19T19:13:08.000\"\n }\n }\n]"}],"_postman_id":"343ed3d3-c164-4eb5-bb88-80e252abee12"},{"name":"Get Completed Records","id":"7f5f37ba-54b4-48f4-80e8-810381e8bbf1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method returns a list of completed records in the calling list that have a completion time that is greater than or equal to the requested initial time (UTC). Input parameters are the initial time in ISO format and the maximum size of the returned list. Current implementation limits \"maxSize\" to 1000 records. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"dffe67a6-dc10-4afa-abe9-471eb66fc0cd","name":"Get Completed Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2021-02-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/getCompleted/:list_name/:campaign_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","getCompleted",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"completedTime\": \"2021-02-19T19:12:37.000\",\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16502222222\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"status\": {\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Product sold\",\n \"totalAttempts\": 1,\n \"completed\": true,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16502222222\",\n \"lastDate\": \"2021-02-19T19:12:37.000\"\n }\n }\n]"}],"_postman_id":"7f5f37ba-54b4-48f4-80e8-810381e8bbf1"},{"name":"Get Updated Records","id":"bb6c74d0-a587-4986-bf35-2ea1aaf57881","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method returns records of the specified calling list that have had any activity within the specified campaign since the requested initial time.
\n","urlObject":{"protocol":"https","path":["configapi","v2","callinglist","getChanged",":list_name",":campaign_name"],"host":["The name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"9500ecb9-b316-46fd-a2f7-74ae98ba2dfb","name":"Get Updated Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2021-01-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/getChanged/:list_name/:campaign_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","getChanged",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"status":"Success","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"entry\": {\n \"firstname\": \"Graham\",\n \"phone\": \"16509999999\",\n \"id\": \"1\",\n \"lastname\": \"Smith\",\n \"status\": \"Gold\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"No disposition\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:11:40.000\",\n \"phone\": \"16509999999\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"0B767156-D012-4F63-A3E2-12ACFC2F26EA\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16507777777\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Try again later\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:12:21.000\",\n \"phone\": \"16507777777\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16505555555\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"completed\": true,\n \"recordDisposition\": \"Product sold\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Product sold\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:12:37.000\",\n \"phone\": \"16505555555\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Jenny\",\n \"phone\": \"16502222222\",\n \"id\": \"4\",\n \"lastname\": \"Green\",\n \"status\": \"Gold\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Fast busy\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:13:08.000\",\n \"phone\": \"16502222222\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"35DE77AC-5A37-4907-97CA-50B09B30ECDF\",\n \"CPADuration\": 0\n }\n ]\n }\n]"}],"_postman_id":"bb6c74d0-a587-4986-bf35-2ea1aaf57881"},{"name":"Query a Record","id":"e171a3f8-b9b2-483a-8e7c-b6a20fc1fd94","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method queries the status of an existing record in the specified calling list in the specified campaign. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"description":{"content":"The name of outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaignname"}]}},"response":[{"id":"197403c3-d22d-4321-9800-9a441569c0ec","name":"Query a Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/get/:list_name/:campaignname","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","get",":list_name",":campaignname"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaignname","value":"Outbound%20Campaign"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16505555555\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"status\": {\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Try again later\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16505555555\",\n \"lastDate\": \"2021-02-19T19:12:21.000\"\n }\n}"}],"_postman_id":"e171a3f8-b9b2-483a-8e7c-b6a20fc1fd94"},{"name":"Update Record","id":"d904e286-fc72-4d29-ad9a-fd4a6db930e9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method updates fields in an existing record in the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. The unique keys cannot be changed.
\nNote: Updating a list record requires internal reprocessing of the entire calling list. Thus, if this method is applied to a list within a running campaign, the use of this list within the given campaign will be suspended until list reprocessing is complete. The suspension time will depend on the list size and, for long lists, may amount to tens of minutes. Other lists associated with the same campaign will not be affected.
\nOther Notes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"5d9ee282-7d10-4968-b10d-fe0bccab3e8c","name":"Update Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"4\",\r\n \"firstName\": \"Posty\",\r\n \"lastName\": \"Melon\",\r\n \"Phone\": \"16505555555\",\r\n \"Status\": \"Platinum\"\r\n}"},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/callinglist/update/:list_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","callinglist","update",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d904e286-fc72-4d29-ad9a-fd4a6db930e9"}],"id":"2a318bb1-f2f2-4897-b1de-ebaa0cb71f3a","event":[{"listen":"prerequest","script":{"id":"a1bc3b13-0f55-4ec1-b3eb-922a3142d673","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"de86ee25-6b23-4f8f-8176-b4cbb11fcef4","type":"text/javascript","exec":[""]}}],"_postman_id":"2a318bb1-f2f2-4897-b1de-ebaa0cb71f3a","description":""},{"name":"Campaigns","item":[{"name":"Get Campaigns","id":"15c80b78-ae55-40d8-bee9-5bf52c9c9f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"BearerThis method returns the list of enabled campaigns and the calling lists currently associated with such campaigns. It does not return any disabled campaigns.
\nNotes:
\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.
\nAn optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal, area codes, and record exclusion DNC lists.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":"","key":"do_not_call_list_name"}]}},"response":[{"id":"3052074c-11f0-4837-8e69-9a2b9754b800","name":"Add Records to DNC","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n [\r\n \"123456789\",\r\n \"optional comment\"\r\n ],\r\n [\r\n \"9999999999\",\r\n \"optional comment\"\r\n ]\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/donotcalllist/add/:do_not_call_list_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","donotcalllist","add",":do_not_call_list_name"],"variable":[{"key":"do_not_call_list_name","value":"DNC_List"}]}},"status":"Success","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"added\": 2\r\n}"}],"_postman_id":"a4450a55-c65f-4b06-8b22-309d255f48cb"},{"name":"Replace Records in DNC","id":"fa686561-9397-4c09-bd51-1f6984f398dc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThe method replaces all records in the specified Do Not Call (DNC) list and returns the number of newly inserted records. Duplicates are ignored. An optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal area codes, and accounts' DNC lists.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":"","key":"do_not_call_list_name"}]}},"response":[{"id":"270def6e-d2ec-4054-b416-853ab6db6a71","name":"Replace Records in DNC","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n [\r\n \"123456789\",\r\n \"optional comment\"\r\n ],\r\n [\r\n \"9999999999\",\r\n \"optional comment\"\r\n ]\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/donotcalllist/replaceAll/:do_not_call_list_name","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","donotcalllist","replaceAll",":do_not_call_list_name"],"variable":[{"key":"do_not_call_list_name","value":"DNC_List"}]}},"status":"Success","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"added\": 2\r\n}"}],"_postman_id":"fa686561-9397-4c09-bd51-1f6984f398dc"},{"name":"Delete All Records","id":"07eb162d-9eb9-4669-bfdf-25ba2d837b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method deletes all records from the specified DNC List and returns the number of deleted records.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":null,"key":"do_not_call_list_name"}]}},"response":[{"id":"d2300170-2860-4c6b-a101-fb6a9ffa0ce7","name":"Delete All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method deletes the list of specified records from the DNC List, returns the number of deleted records and list of errors if there are.
\nInput parameters:
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":null,"key":"do_not_call_list_name"}]}},"response":[{"id":"ed5e8de5-6520-40de-a914-c8b22bf6ed39","name":"Delete Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer