From Bright Pattern Documentation
< 5.2:List-management-api-specification
Revision as of 04:32, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.2 • 5.3 • 5.8

Add Records to DNC

This 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.

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 record exclusion DNC lists.


Request

URL

http[s]://<host>/configapi/v2/donotcalllist/add/<do_not_call_list_name>

Method

POST

Body Content Type

JSON object

Body

[
   "123456789",
   …
   "9999999999"
]

or

[
  [ "123456789", "optional comment"],
   …
   ["9999999999", "optional comment"]
]


Result

Response Codes

Code Description
200 Success
400 Bad request (format not understood)
401 Authentication failed
403 User authenticated but does not have sufficient privileges, or modification of this type of list is not allowed
404 Calling List is not found or invalid URL

Body

{ "added": 9999 }

< Previous | Next >