Skip to main content
PATCH
Atualizar contato

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.

Path Parameters

phone
string
required

Telefone E.164 com + (ex. +5511999999999).

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

Body

application/json
name
string | null

Até 255 caracteres. Vazio é ignorado.

Maximum string length: 255
email
string | null

Até 255 caracteres. String vazia remove o email.

Maximum string length: 255
tags
string[] | null

Substitui a lista inteira. Até 20 tags.

Maximum array length: 20

Response

Contato atualizado

id
string<uuid>
required
name
string
required
phone
string
required
tags
string[]
required
createdAt
string
required
lifecycle
string
required

Estágio do contato: NEW, ENGAGED, SILENT, DORMANT ou OPTED_OUT.

source
string
required

De onde o contato veio (ex. API).

outboundCount
integer<int64>
required
inboundCount
integer<int64>
required
email
string | null
attributes
object | null
firstSeenAt
string | null
lastOutboundAt
string | null
lastInboundAt
string | null
lastMessageAt
string | null
optOutAt
string | null

Quando o contato pediu para não receber.

lastTemplateName
string | null

Último template enviado ao contato.