Update a contact list

patch

https://api.sintalk.com.br/v3/contact-lists/{list_id}

Renames the list and, on a blacklist list, replaces the channels it suppresses on. type is fixed at creation and cannot be patched. Omitting channels leaves them as they are; [] clears them, which stops the list suppressing anything. Setting a non-empty channels on a default list is rejected with 422, and taking a name another list already holds with 409. Which contacts are in the list is changed through the membership endpoints, not here.

Sintalk is provisioned for you and cannot be renamed; renaming it is rejected with 409. Its channels can still be changed.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The contact list after the update.

400The request was rejected before it was applied — either a field failed validation (validation_failed, with error.fields naming each one), or the request could not be read at all (bad_request: malformed JSON, an unknown field, a missing parameter, or an unparseable path or query value).

401No credential was presented, or the one presented was rejected.

403The credential is valid but is not allowed to call this operation.

404No resource with that id exists in your account. An id belonging to another account is reported the same way as one that never existed.

409The request collides with what already exists, or with the resource's current state. Re-read the resource before retrying.

422The body parsed and every field is individually valid, but the request cannot be applied as asked. Retrying it unchanged will fail again.

429Rate limit exceeded

defaultAn unexpected error. Safe to retry with backoff; use an idempotency key where the operation accepts one.