Skip to content
Cloudflare API
Start here
API Reference
Email Sending
Suppressions

Create account Email Sending suppression

client.emailSending.suppressions.create(SuppressionCreateParams { account_id, email, expires_at, 2 more } params, RequestOptionsoptions?): SuppressionCreateResponse { id, scope }
POST/accounts/{account_id}/email/sending/suppressions

Creates a suppression for every sending domain of the account (default) or for one sending domain (scope.type = sending_domain). Creating an existing active suppression returns its identifier. If a mutable legacy zone-linked account row already exists, it is promoted without changing its identifier.

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
ParametersExpand Collapse
params: SuppressionCreateParams { account_id, email, expires_at, 2 more }
account_id: string

Path param: Cloudflare account ID.

email: string

Body param: The email address to suppress.

formatemail
expires_at?: string | null

Body param: Expiration timestamp for the suppression. Omit or set to null for a permanent suppression that never expires.

formatdate-time
note?: string

Body param: Advisory note for this suppression. Not enforced or validated beyond length.

maxLength1000
scope?: Type { type } | UnionMember1 { type, value }

Body param: Where the suppression applies. Omit for { "type": "account" }, which blocks the recipient for every sending domain of the account.

One of the following:
Type { type }
type: "account"

Blocks the recipient for every sending domain of the account.

UnionMember1 { type, value }
type: "sending_domain"

Blocks the recipient only for mail whose envelope MAIL FROM uses value.

value: string

The sending domain to suppress for: the domain part of the envelope MAIL FROM. It is lowercased and trailing dots are removed. Internationalized domains must use the ASCII (punycode) form. Ownership is not checked; a domain the account does not send from never matches.

maxLength1024
ReturnsExpand Collapse
SuppressionCreateResponse { id, scope }
id: string

The suppression’s identifier.

formatuuid
scope?: Type { type } | UnionMember1 { type, value }

Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain.

One of the following:
Type { type }
type: "account"

Blocks the recipient for every sending domain of the account.

UnionMember1 { type, value }
type: "sending_domain"

Blocks the recipient only for mail whose envelope MAIL FROM uses value.

value: string

The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot.

maxLength1024

Create account Email Sending suppression

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const suppression = await client.emailSending.suppressions.create({
  account_id: '12345678',
  email: 'user@example.com',
});

console.log(suppression.id);
{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}