Unsubscribed

Unsubscribed callbacks are triggered when a recipient unsubscribes from your emails. These callbacks allow you to keep your mailing lists up to date and ensure compliance with recipient preferences.

Unsubscribed Webhook Payload

Parameter	Type	Required	Description	Example
channel	string	true	Always email	email
event_type	string	true	Always email_unsubscribed	email_unsubscribed
batch_id	string	true	UUID auto-generated per API send request and returned in the send response. Shared across all recipients (to, cc, bcc) of that single send.	550e8400-e29b-41d4-a716-446655440000
message_id	string	true	Internal identifier for the individual recipient record	507f1f77bcf86cd799439011
tag	string	false	Custom tag sent with the email	welcome-email
bulk_tag	string	false	User-provided string for grouping multiple sends across separate API calls	campaign-april
event_meta	object	true	Event-specific metadata
event_meta.to	string	true	Recipient email address	[email protected]
event_meta.link	string	true	Always empty for this event type	""
event_meta.sent_at	string	true	Timestamp of the event in ISO 8601 format	2024-01-15T10:30:00Z