List account Email Sending suppressions

GET/accounts/{account_id}/email/sending/suppressions

Lists every active Email Sending suppression owned by the account, including legacy rows with internal zone memberships.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Path ParametersExpand Collapse

account_id: string

Query ParametersExpand Collapse

cursor: optional string

Opaque pagination cursor returned as result_info.next_cursor. It carries the filters that produced it.

maxLength2048

email: optional string

Exact email-address filter.

formatemail

per_page: optional number

maximum1000

minimum1

reason: optional "manual" or "complaint" or "hard_bounce" or 2 more

One of the following:

"manual"

"complaint"

"hard_bounce"

"soft_bounce"

"policy"

search: optional string

A complete address is an exact match; a value ending in @ matches that username across every domain. Prefix searches may return short intermediate pages while the bounded account scan advances.

maxLength320

minLength1

ReturnsExpand Collapse

errors: array of unknown

messages: array of unknown

result: array of object { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string

formatdate-time

read_only: boolean

Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason.

reason: string

note: optional string

result_info: object { count, next_cursor, per_page }

count: number

next_cursor: string

Opaque cursor for the next page. Pass it back as the cursor query parameter and continue until it is null. A bounded large-account scan may return a short intermediate page.

per_page: number

success: boolean

List account Email Sending suppressions

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/email/sending/suppressions \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "user@example.com",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "read_only": true,
      "reason": "hard_bounce",
      "note": "Imported from CRM"
    }
  ],
  "result_info": {
    "count": 1,
    "next_cursor": "eyJ0IjozLCJwIjoxMjMsImMiOiJjM2RjNWYwYjM0YTE0ZmY4ZTFiM2VjMDQ4OTVlMWIyMiJ9",
    "per_page": 100
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "user@example.com",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "read_only": true,
      "reason": "hard_bounce",
      "note": "Imported from CRM"
    }
  ],
  "result_info": {
    "count": 1,
    "next_cursor": "eyJ0IjozLCJwIjoxMjMsImMiOiJjM2RjNWYwYjM0YTE0ZmY4ZTFiM2VjMDQ4OTVlMWIyMiJ9",
    "per_page": 100
  },
  "success": true
}