Skip to main content
POST
Create Contact

Authorizations

api_access_token
string
header
required

Body

application/json
name
string
required

Name of the contact

Example:

"Maria Santos"

identifier
string

Unique identifier for the contact (e.g., external ID)

Example:

"maria-santos-123"

email
string<email>

Email address of the contact

phone_number
string

Phone number with country code

Example:

"+5521987654321"

blocked
boolean
default:false

Whether the contact is blocked

Example:

false

avatar_url
string<uri>

URL to download and set as contact's avatar

Example:

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

type
enum<string>
default:person

Type of contact

Available options:
person,
company
Example:

"person"

tax_id
string

Tax ID (CPF/CNPJ)

Example:

"12345678901"

website
string<uri>

Contact's website URL

Example:

"https://empresa.com.br"

industry
string

Industry/sector of the contact or company

Example:

"Technology"

additional_attributes
object

Additional attributes for the contact

Example:
custom_attributes
object

Custom attributes as key-value pairs

Example:
labels
string[]

Labels to assign to the contact

Example:
company_ids
string<uuid>[]

Array of company IDs to associate with this contact (only for person type)

Example:
inbox_id
string<uuid>

Inbox ID to create a contact_inbox association

Example:

"550e8400-e29b-41d4-a716-446655440001"

source_id
string

Source ID for the contact_inbox (e.g., WhatsApp number, email address)

Example:

"+5521987654321"

Response

Contact created successfully

success
boolean
required
Example:

true

data
object
required
message
string
required
Example:

"Contact created successfully"