curl --request POST \
--url https://api.ararahq.com/v1/contacts/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
}
},
{
"name": "Maria Santos",
"phone": "+5511888888888"
}
]
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: 'João Silva',
phone: '+5511999999999',
email: 'joao@exemplo.com',
attributes: {plano: 'pro'}
},
{name: 'Maria Santos', phone: '+5511888888888'}
])
};
fetch('https://api.ararahq.com/v1/contacts/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts/batch"
payload = [
{
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": { "plano": "pro" }
},
{
"name": "Maria Santos",
"phone": "+5511888888888"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => 'João Silva',
'phone' => '+5511999999999',
'email' => 'joao@exemplo.com',
'attributes' => [
'plano' => 'pro'
]
],
[
'name' => 'Maria Santos',
'phone' => '+5511888888888'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}Importar contatos em lote
Cria ou atualiza até 5.000 contatos por chamada. O corpo é um array. O telefone é a chave:
- Telefone novo: cria (
created). - Telefone existente com dados diferentes: atualiza (
updated). - Telefone existente com dados iguais:
skipped, sem erro. - Linha inválida:
skippede entra emerrorscom o índice e o motivo.
No lote, email e attributes substituem o que está gravado: enviar um
contato existente sem email apaga o email dele. Para mudar só um campo,
use PATCH /v1/contacts/{phone}.
importId identifica a chamada nos logs; não há rota para consultá-lo.
Permissão: CONTACTS_WRITE.
curl --request POST \
--url https://api.ararahq.com/v1/contacts/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
}
},
{
"name": "Maria Santos",
"phone": "+5511888888888"
}
]
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
name: 'João Silva',
phone: '+5511999999999',
email: 'joao@exemplo.com',
attributes: {plano: 'pro'}
},
{name: 'Maria Santos', phone: '+5511888888888'}
])
};
fetch('https://api.ararahq.com/v1/contacts/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts/batch"
payload = [
{
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": { "plano": "pro" }
},
{
"name": "Maria Santos",
"phone": "+5511888888888"
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'name' => 'João Silva',
'phone' => '+5511999999999',
'email' => 'joao@exemplo.com',
'attributes' => [
'plano' => 'pro'
]
],
[
'name' => 'Maria Santos',
'phone' => '+5511888888888'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}Authorizations
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
Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.
Body
5000Nome do contato. Obrigatório, até 255 caracteres.
255Telefone E.164 com +. É a chave do contato.
^\+[1-9]\d{6,14}$"+5511999999999"
No lote, substitui o email gravado. Omitir apaga o email de um contato existente.
255Objeto livre com dados do seu sistema. No lote, substitui o que está gravado.