From Bright Pattern Documentation
< 3.12:List-management-api-specification
Revision as of 02:04, 5 August 2016 by Sasha (talk | contribs) (Update a record)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 3.10 • 3.11 • 3.12 • 3.13 • 3.14 • 3.15 • 3.16 • 3.17 • 3.18

Update a record

Description Updates fields of an existing record in 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: Update of a list record requires internal re-processing of the entire calling list. Thus, if this method is applied to a list within a running campaign, use of this list within the given campaign will be suspended until list re-processing 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>:<port>/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


< Previous | Next >
< Previous | Next >