Add a suppression

POST

/v1/email/suppressions

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"
  }'

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.

请求载荷

string

必填

Email address to suppress. Normalized to lowercase before storage.

响应载荷

string

必填

string

必填

scope

object

必填

显示子属性

scope.type

string

必填

The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.

scope.id

string

必填

Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_ prefix).

reason

string

必填

origin

string

必填

applies_to

string

必填

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

必填

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"
  }'