Skip to main content
This object definition applies to legacy unsubscribe endpoints. The new endpoints use different response schemas — see Variables and Contacts.

A record of someone opting out of receiving emails.

_id
string

Unique unsubscribe identifier

email
string<email>

Unsubscribed email address

campaignId
string

Campaign ID from which the person unsubscribed

campaignName
string

Campaign name from which the person unsubscribed

unsubscribedAt
string<date-time>

Unsubscribe timestamp

scope
enum<string>

Unsubscribe scope

Available options:
campaign,
team,
global