Skip to content

Deleting offline inquiries

Method delete.offline_messages
Description Deleting offline inquiries
Who has access Agent, Customer
Components required to work with the method Data API, Uploading offline inquiries from an outside system

You can only delete inquiries uploaded from Data API.
They are marked as "form_type": "DataAPI" in the report "Getting information about offline inquiries" get.offline_messages_report

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key
user_id number no Unique user ID of a customer or a client who makes a request.
Is mandatory for an agent
To get a list of customer users you should use the method "get.customer_users"
id number yes Unique ID of an offline inquiry

JSON request structure

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "delete.offline_messages",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "id": "number"
    }
}

JSON reply structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "success": "true"
  }
}

List of returning errors

Refer to "List of errors common for methods with the verb delete"