Skip to content

Deletes an offline message

Method delete.offline_messages
Description Deletes an offline message
Available to Agent, Client
Required components Data API and Upload Offline Messages from an External System

Only offline messages uploaded through the Data API can be deleted. In get.offline_messages_report, these messages have form_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 ID of the offline message.

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "delete.offline_messages",
    "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.