contact_create_payload

inbox_idnumberrequired

ID of the inbox to which the contact belongs

Example: 1

namestring

name of the contact

Example: Alice

emailstring

email of the contact

Example: alice@acme.inc

blockedboolean

whether the contact is blocked or not

Example: false

phone_numberstring

phone number of the contact

Example: +123456789

avatarstring<binary>

Send the form data with the avatar image binary or use the avatar_url

avatar_urlstring

The url to a jpeg, png file for the contact avatar

Example: https://example.com/avatar.png

identifierstring

A unique identifier for the contact in external system

Example: 1234567890

additional_attributesobject

An object where you can store additional attributes for contact. example {"type":"customer", "age":30}

Example: {"type":"customer","age":30}

custom_attributesobject

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}, this should have a valid custom attribute definition.

Example: {}

contact_create_payload

{
  "inbox_id": 1,
  "name": "Alice",
  "email": "alice@acme.inc",
  "blocked": false,
  "phone_number": "+123456789",
  "avatar": "string",
  "avatar_url": "https://example.com/avatar.png",
  "identifier": "1234567890",
  "additional_attributes": {
    "type": "customer",
    "age": 30
  },
  "custom_attributes": {}
}