Skip to main content
POST
Create a contact

Path Parameters

inbox_identifier
string
required

The identifier obtained from API inbox channel

Body

application/json
identifier
string

External identifier of the contact

Example:

"1234567890"

identifier_hash
string

Identifier hash prepared for HMAC authentication

Example:

"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9"

email
string

Email of the contact

Example:

"alice@acme.inc"

name
string

Name of the contact

Example:

"Alice"

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

custom_attributes
object

Custom attributes of the customer

Example:

Response

Success

id
integer

Id of the contact

source_id
string

The session identifier of the contact

name
string | null

Name of the contact when available

email
string | null

Email of the contact

phone_number
string | null

Phone number of the contact

pubsub_token
string

The token to be used to connect to Voxys Connect websocket