Skip to navigation
API ReferenceContacts

Create a contact

Creates a contact. email, phone_number, and identifier are each unique in the account. A value that another contact has already fails with 422. A new contact has no conversation.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

Request

This endpoint expects an object.
namestringOptional
emailstringOptionalformat: "email"
phone_numberstringOptionalformat: "^\+[1-9]\d{1,14}$"
identifierstringOptional
blockedbooleanOptional
avatar_urlstringOptional
The URL of an image. The API downloads it as the avatar of the contact.
custom_attributesmap from strings to anyOptional
additional_attributesmap from strings to anyOptional

Response

The new contact.
payloadobjectOptional

Errors

401
Unauthorized Error
422
Unprocessable Entity Error