Skip to main content
POST
Importar contatos em lote

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Headers

X-Waba-Id
string<uuid>

Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.

Body

application/json
Maximum array length: 5000
name
string
required

Nome do contato. Obrigatório, até 255 caracteres.

Maximum string length: 255
phone
string
required

Telefone E.164 com +. É a chave do contato.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+5511999999999"

email
string | null

No lote, substitui o email gravado. Omitir apaga o email de um contato existente.

Maximum string length: 255
attributes
object | null

Objeto livre com dados do seu sistema. No lote, substitui o que está gravado.

Response

Resultado da importação

importId
string<uuid>
required

Identifica a chamada nos logs. Não há rota para consultá-lo.

created
integer
required
updated
integer
required
skipped
integer
required
errors
object[]
required