Skip to content

Updates a deal contact.

Method update.deal_contacts
API version
Description Updates a deal contact.

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 contact ID.
name string no Contact name.
created_date_time iso8601 no Date and time when the contact was created in the CRM, in YYYY-MM-DD hh:mm:ss format.
phone_numbers array no Complete current list of contact phone numbers in E.164 format. This array replaces the existing list.
emails array no Complete current list of contact email addresses. This array replaces the existing list.

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "update.deal_contacts",
    "params": {
        "access_token":"string",
        "user_id":"number",
        "ext_id": "string",
        "name": "string",
        "created_date_time": "iso8601",
        "phone_numbers": [
            "string"
        ],
        "emails": [
            "string"
        ]
    }
}

Example response

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

Possible errors

See the "Errors for update methods" section.