Webhook event · Tracking
tracking_preferences_updated
Sent when a recipient changes their open or click tracking choice on the tracking preferences page. They keep receiving your emails: this is not an unsubscribe.
Delivered as a signed POST to your webhook URL. See Setup & Events for how to verify the signature.
Payload
// Turned open tracking off (API / SMTP email)
{
"event": "tracking_preferences_updated",
"timestamp": "2026-10-24T07:20:12.031Z",
"data": {
"recipientEmail": "jane.doe@example.com",
"trackOpens": false,
"trackClicks": true,
"source": "page",
"updatedAt": "2026-10-24T07:20:12.031Z",
"trackId": "a41f9c0e7b2d58e6"
}
}Only when something changed Saving the same choice again does not send the webhook. Changes you make yourself with Set Preferences are not sent either, so your CRM sync never loops. A refusal is applied to your sends right away: emails sent with "unsubscribe": true leave out the pixel and the tracked links for that recipient.
Tracking Preferences API Read one recipient or 100 at once, see the full history of a recipient, and poll every change with a cursor.
Tracking Preferences →Field reference
eventFixed value: "tracking_preferences_updated"
timestampWhen the change was processed (ISO 8601, UTC).
data.recipientEmailThe recipient who changed their preference.
data.trackOpenstrue: the recipient allows open tracking. false: they refused it.
data.trackClickstrue: the recipient allows click tracking. false: they refused it.
data.sourceFixed value for now: "page" (the recipient used the tracking preferences page).
data.updatedAtWhen the preference was saved (ISO 8601, UTC). The same value as updated_at in the API.
data.campaignIdThe campaign of the email the recipient came from. Only for campaign emails.
data.trackIdTracking key of the email, for emails sent through the API or SMTP. Only when tracking was on for that send.