Evento de webhook · Tracking

unsubscribe

Enviado quando um destinatário cancela a inscrição a partir de um dos seus emails: na página de descadastro, pelo botão de um clique da caixa de email dele (Gmail, Yahoo, Outlook) ou por email através do header List-Unsubscribe.

i

Enviado como um POST assinado para a sua URL de webhook. Veja Configuração e eventos para saber como verificar a assinatura.

Payload

// Unsubscribed from a campaign (one-click)
{
  "event": "unsubscribe",
  "timestamp": "2026-10-20T14:32:07.123Z",
  "data": {
    "recipientEmail": "jane.doe@example.com",
    "source": "one_click",
    "campaignId": "9b2e4f10-6c3a-4d7e-8a51-2f0c9d6b7e34"
  }
}
!

Vale para o contato inteiro O contato é marcado como descadastrado e para de receber todas as campanhas, em todas as listas de que faz parte. Ele continua nas suas listas com o histórico, então reimportar uma lista não o inscreve de novo. Abrir o link de descadastro sem clicar no botão não descadastra (scanners de segurança abrem links automaticamente).

Referência dos campos

  • event

    Valor fixo: "unsubscribe"

  • timestamp

    Quando o descadastro foi processado (ISO 8601, UTC).

  • data.recipientEmail

    O endereço de email que se descadastrou.

  • data.source

    Como o destinatário se descadastrou: "page" (página de descadastro), "one_click" (botão de um clique da caixa de email, RFC 8058) ou "email" (email de descadastro enviado ao endereço mailto do List-Unsubscribe).

  • data.campaignId

    ID da campanha de onde veio o descadastro. Só para emails de campanha.

  • data.trackId

    Chave de tracking do email, para emails enviados pela API ou por SMTP. Só quando o tracking estava ativo nesse envio.