Deletes a chat
| Method | delete.chats |
|---|---|
| Description | Deletes a chat |
| Available to | Agent, Client |
| Required components | Data API and Upload Chats from an External System |
Only chats uploaded through the Data API can be deleted. In get.chats_report, these chats have chat_channel_type set to dataapi.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Access token used to authenticate the request. |
user_id |
number | no | Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use the "get.customer_users" method. |
id |
number | yes | Unique chat ID. |
Example request
{
"jsonrpc": "2.0",
"id": "number",
"method": "delete.chats",
"params": {
"access_token": "string",
"user_id": "number",
"id": "number"
}
}
Example response
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"success": true
}
}
Possible errors
See the "Errors for delete methods" section.