Skip to content

Updates a custom field for offline messages

Method update.offline_message_user_field
Description Updates a custom field for offline messages
Available to Agent, Client

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.
ext_id string yes External ID of the custom field.
name string yes Custom field name.

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "update.offline_message_user_field",
    "params": {
        "access_token":"string",
        "user_id":"number",
        "ext_id": "string",
        "name": "string"
    }
}

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "update.offline_message_user_field",
    "params": {
        "access_token":"string",
        "ext_id": "field_2021012203_3",
        "name": "Order status"
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": {
            "ext_id": "string"
        },
        "metadata": "object"
    }
}

Possible errors

See the "Errors for update methods" section.