Bulk Deleting Interactions

Bulk delete resource of interaction by type and IDs. (Only Chat channel is supported currently).

👍

Access and Registration

Authentication

Scope

omnichannel:interaction-elimination

Body Response

200 (OK) - Interaction successfully deleted

ParameterTypeDescriptionRequired
idstringThe ID of the request.
> = 1 characters
<= 32 characters
yes
has_errorsbooleanIndicates whether there were errorsyes
errorsarray[object]

"errors" subdivides into:

  1. "interaction_id" (string) - The ID of the interaction that caused the error.
    > = 1 characters
    > &lt;= 32 characters

  2. "code" (integer) - The error code.

  3. "message" (string) -

yes
total_deletedintegerThe total number of interaction resources deleted.yes
total_errorsintegerThe total number of errors.yes

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 500 (internal server error)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]

"fields" subdivides into:

"name" (string)

"description" (string)

yes (name and description)
🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!