Contatos

Descadastrar contato

POSThttps://api.seudominio.com.br/integrations/v1/contacts/{id}/opt-out

O contato para de receber mensagens automáticas.

Mesma regra de CRM › Contatos › Descadastrar: campanhas pulam o contato, ele sai das sequências em andamento e chatbots automáticos (API, campanha, sequência, evento, webhook) não iniciam com ele. As conversas com a equipe continuam normais.

É idempotente: se o contato já estava descadastrado, devolve changed: false. Quando muda, dispara o evento contact.opted_out para os webhooks.

Parâmetros de caminho

idintegerobrigatório

Id do contato.

Respostas

AnteriorAtualizar contato Próximo Recadastrar contato

Token (Bearer)

Fica só nesta aba do navegador e é usado nos exemplos abaixo.

curl --request POST \
  --url 'https://api.seudominio.com.br/integrations/v1/contacts/{id}/opt-out' \
  --header 'Authorization: Bearer sk_SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

A chamada é real: age sobre os dados do seu workspace.

Resposta

{
  "contact_id": 35,
  "opted_out": true,
  "changed": true
}