ARararahq
Contatos

Atualizar contato

Changed on

Atualiza só os campos enviados. Campo omitido não muda. Permissão: CONTACTS_WRITE.

patch/v1/contacts/{phone}

Request

Path parameters

phonestring required

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

Request body

namestring nullable

Até 255 caracteres. Vazio é ignorado.

emailstring nullable

Até 255 caracteres. String vazia remove o email.

tagsstring[] nullable

Substitui a lista inteira. Até 20 tags.

Response

Contato atualizado

idstring uuid required
namestring required
phonestring required
emailstring nullable
attributesobject nullable
tagsstring[] required
createdAtstring required
lifecyclestring required

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

sourcestring required

De onde o contato veio (ex. API).

outboundCountinteger required
inboundCountinteger required
firstSeenAtstring nullable
lastOutboundAtstring nullable
lastInboundAtstring nullable
lastMessageAtstring nullable
optOutAtstring nullable

Quando o contato pediu para não receber.

lastTemplateNamestring nullable

Último template enviado ao contato.

Example 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"
}

Changes