From Bright Pattern Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.
• 5.19 • 5.2 • 5.3 • 5.8

Update Record

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

Note: 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.

Request

URL

http[s]://<host>/configapi/v2/callinglist/update/<list_name>

Method

POST

Body Content Type

JSON object

Body

{
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
} 

Notes

  • Field names are provided as they were defined during list creation.
  • The request can contain either a full or partial set of fields for the object, but the key fields are mandatory.


Response Codes

Code Description
200 Success
400 Bad request (missing required fields or format not understood)
401 Authentication failed
403 User authenticated but does not have sufficient privileges
404 Calling List is not found, record is not found, or invalid URL (body is empty)


< Previous | Next >