Webhook event · Tracking

unsubscribe

Sent when a recipient unsubscribes from one of your emails: on the unsubscribe page, with the one-click button of their mailbox (Gmail, Yahoo, Outlook) or by email through the List-Unsubscribe header.

i

Delivered as a signed POST to your webhook URL. See Setup & Events for how to verify the signature.

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

Applies to the whole contact The contact is marked as unsubscribed and stops receiving every campaign, in every list it belongs to. It stays in your lists with its history, so re-importing a list does not subscribe it again. Opening the unsubscribe link without clicking the button does not unsubscribe (security scanners open links automatically).

Field reference

  • event

    Fixed value: "unsubscribe"

  • timestamp

    When the unsubscribe was processed (ISO 8601, UTC).

  • data.recipientEmail

    The email address that unsubscribed.

  • data.source

    How the recipient unsubscribed: "page" (unsubscribe page), "one_click" (mailbox one-click button, RFC 8058) or "email" (unsubscribe email sent to the List-Unsubscribe mailto address).

  • data.campaignId

    ID of the campaign the unsubscribe came from. Only for campaign emails.

  • data.trackId

    Tracking key of the email, for emails sent through the API or SMTP. Only when tracking was on for that send.