Registrar que o lead não quer receber mensagens

Atalho de POST /leads/{id}/consent para uma retirada com origem manual: marca o lead como "não quer receber mensagens" e retira o consentimento registrado, gravando o evento consent_withdrawn no histórico. A partir daí os envios para ele passam a ser recusados antes de qualquer cobrança: nenhuma campanha (oficial ou não oficial) envia para ele, e a entrada fica com o código 920002 (opted_out), inclusive em campanhas criadas antes da marca; um modelo avulso (nova conversa, modelo numa conversa, mensagem agendada, envio pela Elo) responde lead_opted_out; um fluxo de automação não envia nada para ele (texto, mídia, botões, lista ou modelo; o passo falha com lead_opted_out), menos uma única confirmação de saída configurada pelo usuário. Listas de ligação também o deixam de fora; uma ligação direta continua possível. Registra a origem em source: operator (a equipe decidiu, o padrão quando o corpo vem vazio ou sem source) ou lead_request (o lead pediu); a origem volta em optOutSource e fica no histórico de alterações. Só uma nova autorização explícita com prova (POST /leads/{id}/consent com kind grant, ou whatsappOptIn em PUT /leads/{id}, que exige leads:consent) desfaz a marca; importações e canais nunca a desfazem. Não exige If-Match; repetir o pedido não muda nada (a primeira origem fica). Uma chave desconhecida no corpo responde 400 invalid_body; uma origem desconhecida, 400 lead_opt_out_source_invalid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID do lead (UUID)

Body Params

Origem do pedido (opcional)

string
enum
Allowed:
Headers
string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json