| Method | create.offline_message_user_field |
|---|---|
| Description | Loading custom application fields |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
ext_id |
string | yes | External ID of the application custom field |
name |
string | yes | Application custom field name |
data_type |
enum | yes | The data type in the field. Takes one of two values numeric and string |
Response parameters
| Title | Type | Required | Description |
|---|---|---|---|
ext_id |
string | yes | External ID of the application custom field |
JSON request structure```json
{ "jsonrpc": "2.0", "id": "number", "method": "create.offline_message_user_field", "params": { "access_token":"string", "user_id":"number", "ext_id": "string", "name": "string", "data_type": "enum" } }
### JSON example request structure```JSON
{
"jsonrpc": "2.0",
"id": "number",
"method": "create.offline_message_user_field",
"params": {
"access_token":"string",
"ext_id": "field_2021012203_3",
"name": "Проданы ли кони",
"data_type": "string"
}
}
JSON response structure```JSON
{ "jsonrpc": "2.0", "id": "number", "result": { "data": { "ext_id": "string" }, "metadata": "object" } } ```
List of returned errors
See the section "List of errors for methods with the create verb"