Creates a custom deal field.

Method	create.deal_user_field
API version	—
Description	Creates a custom deal field.

Available to: Agents and clients

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 "get.customer_users".
ext_id	string	yes	External custom field ID.
name	string	yes	Custom deal field name.
data_type	enum	yes	Field data type. Valid values: numeric, string.

Response parameters

Name	Type	Required	Description
ext_id	string	yes	External custom field ID.

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.deal_user_field",
    "params": {
        "access_token":"string",
        "user_id":"number",
        "ext_id": "string",
        "name": "string",
        "data_type": "enum"
    }
}

Example request with sample data

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.deal_user_field",
    "params": {
        "access_token":"string",
        "ext_id": "field_2021012203_3",
        "name": "Horses sold",
        "data_type": "string"
    }
}

Example response

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

Possible errors

See the "Errors for create methods" section.