Add a suppression
POST
/v1/email/suppressions
Manually adds an email address to the suppression list with reason "manual" and origin set to "user" for session/cookie callers or "api_key" for API-key callers. Idempotent — if the address is already suppressed, returns 200 with the existing record instead of 409. Use DELETE then POST to change the reason on an existing suppression.
Request Payload
email
string
required
Email address to suppress. Normalized to lowercase before storage.
Response Payload
id
string
required
email
string
required
scope
object
required
Show child attributes
type
string
required
The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
id
string
required
Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_ prefix).
reason
string
required
origin
string
required
applies_to
string
required
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
required
cURL
curl -X POST "https://us1.platform.bird.com/v1/email/suppressions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "jane@example.com"
}'