Contatos

​

O objeto contato

​

Importar contatos

curl -X POST https://api.ararahq.com/v1/contacts/batch \
  -H "Authorization: Bearer $ARARA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "João Silva", "phone": "+5511999999999", "email": "joao@exemplo.com", "attributes": { "plano": "pro" } },
    { "name": "Maria Santos", "phone": "5511888888888" }
  ]'

{
  "importId": "fa1b2c3d-4567-89ab-cdef-0123456789ab",
  "created": 1,
  "updated": 0,
  "skipped": 1,
  "errors": [
    { "index": 1, "phone": "5511888888888", "reason": "Telefone 5511888888888 fora do formato E.164." }
  ]
}

​

Regras que valem saber

• O lote substitui email e attributes. Enviar um contato existente sem email apaga o email dele. Para mudar só um campo, use PATCH /v1/contacts/{phone}.
• Telefone igual, dados iguais: skipped. Não é erro.
• No PATCH, campo omitido não muda. tags substitui a lista inteira, e email como string vazia remove o email.
• Telefone no caminho vai com +. Exemplo: /v1/contacts/+5511999999999.
• Contato inexistente responde 422. Hoje GET /v1/contacts/{phone} devolve 422 UNPROCESSABLE_ENTITY, e não 404.
• A lista tem envelope próprio. GET /v1/contacts responde { contacts, total, page, size, totalPages }, e não { data, pagination }.
• importId é só para log. Não há rota para consultá-lo depois.

​

Opt-out

​

Direitos do titular (LGPD)

​

Endpoints

​

Erros mais comuns

​

Próximos passos