email-suppressions

Get an email suppression

Returns one suppression record:

  • The address.
  • Why it is suppressed (reason).
  • How the record came to exist (origin).
  • 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.

get/v1/email/suppressions/{suppression_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/suppressions/{suppression_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Suppression object.

idstring required
emailstring email required

The suppressed address, stored lowercase.

reasonstring required

Why the address is suppressed:

  • hard_bounce: A delivery permanently failed.
  • complaint: The recipient reported a message as spam.
  • manual: Added through the API or dashboard.
  • unsubscribe: The recipient opted out. Deprecated, and no new record carries it: an opt-out is a messaging preference rather than a suppression. Legacy records remain visible until they are moved to messaging preferences.

An address can hold one record per reason. This list grows over time. Treat unknown values as informational rather than rejecting the record.

originstring required

How the suppression came to exist:

  • bounce_event: Created automatically from a hard bounce.
  • complaint_event: Created from a spam complaint.
  • api_key: Added through the API with an API key.
  • user: Added by a user in the dashboard.
  • unsubscribe_event: The mailbox provider reported an opt-out. Deprecated with reason: unsubscribe.
  • unsubscribe_link: The recipient used a Bird unsubscribe link. Deprecated with reason: unsubscribe.

This list grows over time. Treat unknown values as informational rather than rejecting the record.

applies_tostring required

Which sends the suppression blocks.

  • all: blocks every message category, including transactional.
  • non_transactional: blocks marketing but allows transactional messages. A recipient who complained can therefore still receive mail such as password resets.
  • category: scopes the block to a preference category and blocks every category until one is set.

This list grows over time, and any value other than non_transactional blocks every category, so treat an unknown value as blocking the send.

source_email_idstring
source_recipient_idstring
created_atstring date-time required

When the address was suppressed.

Example response

{
  "id": "sup_01krdgeqcxet5s7t44vh8rt9mg",
  "email": "user@example.com",
  "scope": {
    "id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "source_email_id": "em_01krdgeqcxet5s7t44vh8rt9mg",
  "source_recipient_id": "er_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.