Update account Email Sending suppression

PATCH/accounts/{account_id}/email/sending/suppressions/{suppression_id}

Updates expiry or advisory note fields without changing legacy internal zone memberships. Scope cannot be changed.

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

Cloudflare account ID.

suppression_id: string

The suppression’s identifier.

formatuuid

Body ParametersJSONExpand Collapse

expires_at: optional string

New expiry. Send null to make the suppression permanent; omit to leave it unchanged.

formatdate-time

note: optional string

Replacement advisory note. Send an empty string to clear it; omit to leave it unchanged.

maxLength1000

scope: optional unknown

Not editable. Scope is fixed when the suppression is created; any value returns 400 with code scope_immutable. Delete and recreate the suppression to change it.

ReturnsExpand Collapse

errors: array of unknown

messages: array of unknown

result: object { id, created_at, email, 5 more }

id: string

Unique identifier for this suppression.

formatuuid

created_at: string

When the suppression was created.

formatdate-time

email: string

The suppressed email address.

formatemail

expires_at: string

When the suppression expires. Null for a permanent suppression.

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

Why the address is suppressed: manual, complaint, hard_bounce, soft_bounce, or policy.

note: optional string

Advisory note for this suppression, if any.

scope: optional object { type } or object { 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 object { type }

type: "account"

Blocks the recipient for every sending domain of the account.

object { 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

success: boolean

Update account Email Sending suppression

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

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "created_at": "2026-01-02T02:20:00Z",
    "email": "user@example.com",
    "expires_at": "2027-01-01T00:00:00Z",
    "read_only": false,
    "reason": "hard_bounce",
    "note": "Imported from CRM",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "created_at": "2026-01-02T02:20:00Z",
    "email": "user@example.com",
    "expires_at": "2027-01-01T00:00:00Z",
    "read_only": false,
    "reason": "hard_bounce",
    "note": "Imported from CRM",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}