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 the suppression record for the given ID, including the email address, reason, and scope.
Payload di risposta
id
string
obbligatorio
email
string
obbligatorio
scope
object
obbligatorio
Mostra attributi secondari
scope.type
string
obbligatorio
The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
scope.id
string
obbligatorio
Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_ prefix).
reason
string
obbligatorio
origin
string
obbligatorio
applies_to
string
obbligatorio
Blocking policy. "all" blocks every category. "non_transactional" blocks marketing and future non-transactional categories but allows transactional. "category" is reserved for category-specific preferences.
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
obbligatorio