Contatos

Descadastrar pelo telefone

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

Descadastra o contato achado pelo telefone (ou pelo id no corpo).

Útil para formulários de descadastro e sistemas que só conhecem o número. O telefone aceita qualquer formato (com ou sem +55, espaços e traços). Se nenhum contato tiver o número, devolve 404 — nenhum contato é criado.

Corpo da requisição

application/json

phone_numberstring (telefone)

Telefone do contato.

contact_idinteger

Ou o id do contato.

Corpo para testar

Respostas

AnteriorRecadastrar contato Próximo Recadastrar pelo telefone

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/opt-out' \
  --header 'Authorization: Bearer sk_SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "11999990000"
}'

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

Resposta

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