Skip to content

Deletes a custom deal field.

Method delete.deal_user_field
API version
Description Deletes 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.

Example request

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

Example response

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

Possible errors

See the "Errors for delete methods" section.