Skip to main content

​
What is an unsubscribed event?

An unsubscribed event is generated when a recipient clicks the unsubscribe link in an email message. This indicates that they no longer wish to receive emails from the sender. The recipient’s email address is automatically added to your suppression list so you won’t accidentally send mail to them again, but you should remove the address from your mailing list as well. For more information, see suppressions and unsubscribe handling.

​
What to do if you receive an unsubscribed event

If you receive an unsubscribed event, you should remove the recipient’s email address from your mailing list to avoid sending to them again in the future.
Don’t already have unsubscribe links in your emails? See how to add them on the Unsubscribe page.

​
Fields for unsubscribed events

  • email: Sender email address.
  • customer_handle: Your account ID.
  • timestamp: Unix timestamp of the event.
  • event: The type of event, unsubscribed in this case.
  • recipients: List of recipient email addresses that unsubscribed.
  • campaign_id (optional): The campaign ID associated with the message, if applicable.
  • request_id (optional): A unique identifier generated to track the original HTTP request. This will be blank if the message is sent via SMTP instead of the API.
  • smtp_id: A unique identifier used to track the message, matching the Message-Id header.

​
Example unsubscribed event

{
    "email": "sender@example.com",
    "customer_handle": "examplecorp",
    "timestamp": 1700000000,
    "event": "unsubscribed",
    "recipients": [
        "recipient@example.net"
    ],
    "campaign_id": "spring-sale-2026",
    "request_id": "4b06083a23724f279c8d11a370e641f8",
    "smtp_id": "<c8d0c0e8412a4e9e9687814d9a7c67da@example.com>"
}