From Bright Pattern Documentation
Contents
- Introduction
- API Specification
- General Information
- Get campaigns
- 1 Add a record
- Add a number of records
- Update a record
- Query a record
- Delete all records
- Get completed records
- Get updated records
- Get all records
- Add records to DNC
- Replace records in DNC
List Management API Specification
Add a record
Add a record adds a single new record to the specified calling list. In addition, it returns an error if a record with the same values of unique keys already exists in the specified list.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/add/<list_name>
Method
POST
Request body
Names and values of record fields (content type: application/json)
Example
{
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
}
Returns
204 – Record added
Errors
400 – Bad request (missing mandatory fields or incorrect format)
401 – Authentication failed
403 – Authentication succeeded, but authorization failed (no privileges)
404 – Calling list not found
500 – Duplicate key (record with same values of unique keys already exists)