Get a suppression
GET
/v1/email/suppressions/{suppression_id}
curl -X GET "https://us1.platform.bird.com/v1/email/suppressions/{suppression_id}" \
-H "Authorization: Bearer $TOKEN"Returns one suppression record: the address, why it is suppressed (reason), how the record came to exist (origin), and which message categories it blocks (applies_to). To find a record when you only know the address, use GET /v1/email/suppressions with the email parameter. An ID that does not exist in the workspace returns 404.
Contenu de la réponse
id
string
obligatoire
email
string
obligatoire
The suppressed address, stored lowercase.
scope
object
obligatoire
Afficher les attributs enfants
scope.type
string
obligatoire
The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
Possible values: workspace, category, audience, topic, contact, domain
scope.id
string
obligatoire
Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_-prefixed).
reason
string
obligatoire
Why the address is suppressed: hard_bounce (a delivery permanently failed), complaint (the recipient reported a message as spam), unsubscribe (the recipient opted out), or manual (added through the API or dashboard). An address can hold one record per reason. This list grows over time; treat unknown values as informational rather than rejecting the record.
Possible values (may grow over time): hard_bounce, complaint, unsubscribe, manual
origin
string
obligatoire
How the suppression came to exist: bounce_event (created automatically from a hard bounce), complaint_event (from a spam complaint), unsubscribe_event (from an unsubscribe reported for a message, such as the recipient's mail client's unsubscribe action), unsubscribe_link (the recipient opted out through the unsubscribe page linked from a message), api_key (added through the API with an API key), or user (added by a user in the dashboard). This list grows over time; treat unknown values as informational rather than rejecting the record.
Possible values (may grow over time): bounce_event, complaint_event, unsubscribe_event, unsubscribe_link, api_key, user
applies_to
string
obligatoire
Which sends the suppression blocks. all blocks every message category, including transactional. non_transactional blocks marketing and future non-transactional categories but allows transactional, so a recipient who complained or unsubscribed can still receive mail like password resets. category is reserved for category-specific preferences. This list grows over time; treat an unknown value as blocking at least non-transactional mail.
Possible values (may grow over time): all, non_transactional, category
source_email_id
nullable string
ID of the email that triggered suppression. Null for manual additions.
source_recipient_id
nullable string
ID of the recipient event that triggered suppression. Null for manual additions.
created_at
string
obligatoire
When the address was suppressed.