Skip to main content
POST
Create Contact

Autorizações

api_access_token
string
header
obrigatório

Corpo

application/json
name
string
obrigatório

Name of the contact

Exemplo:

"Maria Santos"

identifier
string

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

Exemplo:

"maria-santos-123"

email
string<email>

Email address of the contact

phone_number
string

Phone number with country code

Exemplo:

"+5521987654321"

blocked
boolean
padrão:false

Whether the contact is blocked

Exemplo:

false

avatar_url
string<uri>

URL to download and set as contact's avatar

Exemplo:

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

type
enum<string>
padrão:person

Type of contact

Opções disponíveis:
person,
company
Exemplo:

"person"

tax_id
string

Tax ID (CPF/CNPJ)

Exemplo:

"12345678901"

website
string<uri>

Contact's website URL

Exemplo:

"https://empresa.com.br"

industry
string

Industry/sector of the contact or company

Exemplo:

"Technology"

additional_attributes
object

Additional attributes for the contact

Exemplo:
custom_attributes
object

Custom attributes as key-value pairs

Exemplo:
labels
string[]

Labels to assign to the contact

Exemplo:
company_ids
string<uuid>[]

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

Exemplo:
inbox_id
string<uuid>

Inbox ID to create a contact_inbox association

Exemplo:

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

source_id
string

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

Exemplo:

"+5521987654321"

Resposta

Contact created successfully

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório
message
string
obrigatório
Exemplo:

"Contact created successfully"