Atualizar contato
curl --request PATCH \
--url https://api.ararahq.com/v1/contacts/{phone} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "João S.",
"tags": [
"vip",
"black-friday"
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'João S.', tags: ['vip', 'black-friday']})
};
fetch('https://api.ararahq.com/v1/contacts/{phone}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts/{phone}"
payload = {
"name": "João S.",
"tags": ["vip", "black-friday"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts/{phone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'João S.',
'tags' => [
'vip',
'black-friday'
]
]),
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;
}{
"id": "1f2e3d4c-5b6a-7890-abcd-ef1234567890",
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
},
"tags": [
"vip"
],
"createdAt": "2026-09-01T14:30:00Z",
"lifecycle": "ENGAGED",
"source": "API",
"outboundCount": 12,
"inboundCount": 3,
"firstSeenAt": "2026-09-01T14:30:00Z",
"lastOutboundAt": "2026-09-14T10:00:00Z",
"lastInboundAt": "2026-09-14T10:05:00Z",
"lastMessageAt": "2026-09-14T10:05:00Z",
"optOutAt": null,
"lastTemplateName": "pedido_confirmado"
}Contatos
Atualizar contato
Atualiza só os campos enviados. Campo omitido não muda. Permissão: CONTACTS_WRITE.
PATCH
/
v1
/
contacts
/
{phone}
Atualizar contato
curl --request PATCH \
--url https://api.ararahq.com/v1/contacts/{phone} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "João S.",
"tags": [
"vip",
"black-friday"
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'João S.', tags: ['vip', 'black-friday']})
};
fetch('https://api.ararahq.com/v1/contacts/{phone}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts/{phone}"
payload = {
"name": "João S.",
"tags": ["vip", "black-friday"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts/{phone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'João S.',
'tags' => [
'vip',
'black-friday'
]
]),
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;
}{
"id": "1f2e3d4c-5b6a-7890-abcd-ef1234567890",
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
},
"tags": [
"vip"
],
"createdAt": "2026-09-01T14:30:00Z",
"lifecycle": "ENGAGED",
"source": "API",
"outboundCount": 12,
"inboundCount": 3,
"firstSeenAt": "2026-09-01T14:30:00Z",
"lastOutboundAt": "2026-09-14T10:00:00Z",
"lastInboundAt": "2026-09-14T10:05:00Z",
"lastMessageAt": "2026-09-14T10:05:00Z",
"optOutAt": null,
"lastTemplateName": "pedido_confirmado"
}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.
Path Parameters
Telefone E.164 com + (ex. +5511999999999).
Pattern:
^\+[1-9]\d{6,14}$Body
application/json
Response
Contato atualizado
Estágio do contato: NEW, ENGAGED, SILENT, DORMANT ou OPTED_OUT.
De onde o contato veio (ex. API).
Quando o contato pediu para não receber.
Último template enviado ao contato.