Skip to main content
POST
Create Contact

Authorizations

api_access_token
string
header
required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id
integer
required

The numeric ID of the account

Body

application/json
inbox_id
number
required

ID of the inbox to which the contact belongs

Example:

1

name
string

name of the contact

Example:

"Alice"

email
string

email of the contact

Example:

"alice@acme.inc"

blocked
boolean

whether the contact is blocked or not

Example:

false

phone_number
string

phone number of the contact

Example:

"+123456789"

avatar
file

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

avatar_url
string

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

Example:

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

identifier
string

A unique identifier for the contact in external system

Example:

"1234567890"

additional_attributes
object

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

Example:
custom_attributes
object

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

Example:

Response

Success

payload
object[]
id
number

Id of the user

availability_status
enum<string>

Availability status of the user

Available options:
online,
offline