Skip to content

Creates a deal contact.

Method create.deal_contacts
API version
Description Creates 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".
contacts array yes Contacts to create. Maximum: 1,000 contacts per request.
ext_id string yes External contact ID.
name string yes 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. Defaults to the time of the API request.
phone_numbers array no Contact phone numbers in E.164 format.
emails array no Contact email addresses. Each address must be unique within the array.

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.deal_contacts",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "contacts": [
            {
                "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 create methods" section.