(Created new topic from branched topic Documentation:ServicePattern:list-management-api-specification:Updatearecord:3.15) |
|||
| Line 5: | Line 5: | ||
== URL == | == URL == | ||
| − | http[s]:// | + | http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/update/<list_name> |
== Method == | == Method == | ||
| Line 14: | Line 14: | ||
=== Example === | === Example === | ||
| − | { | + | { |
| − | + | "fieldName_1":"value_1", | |
| − | + | ... | |
| − | + | "fieldName_n":"value_n" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
== Returns == | == Returns == | ||
| Line 38: | Line 35: | ||
| − | + | ||
</translate> | </translate> | ||
Latest revision as of 22:55, 17 September 2018
Contents
- Introduction
- API Specification
- General Information
- Get campaigns
- Add a record
- Add a number of records
- 1 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
Update a record
This updates fields of an existing record in the specified calling list. The request can contain either a full or a partial set of fields. All unique keys must be present and their values 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.
URL
http[s]://<host>/admin/ws/t/<tenant_url>/callinglist/update/<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 updated
Errors
400 – Bad request (missing mandatory fields or incorrect format)
401 – Authentication failed
403 – Authentication succeeded, but authorization failed (no privileges)
404 – Calling list is not found, or record is not found, or URL is invalid