Update account Email Sending suppression

email_sending.suppressions.edit(, ) -> SuppressionEditResponse

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

ParametersExpand Collapse

account_id: str

Cloudflare account ID.

suppression_id: str

The suppression’s identifier.

formatuuid

expires_at: Optional[Union[str, datetime, null]]

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

formatdate-time

note: Optional[str]

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

maxLength1000

scope: Optional[object]

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

class SuppressionEditResponse: …

id: str

Unique identifier for this suppression.

formatuuid

created_at: datetime

When the suppression was created.

formatdate-time

email: str

The suppressed email address.

formatemail

expires_at: Optional[datetime]

When the suppression expires. Null for a permanent suppression.

formatdate-time

read_only: bool

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

reason: str

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

note: Optional[str]

Advisory note for this suppression, if any.

scope: Optional[Scope]

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:

class ScopeType: …

type: Literal["account"]

Blocks the recipient for every sending domain of the account.

class ScopeUnionMember1: …

type: Literal["sending_domain"]

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

value: str

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

maxLength1024

Update account Email Sending suppression

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.email_sending.suppressions.edit(
    suppression_id="396a5436-d4b0-42a6-b3fc-48e8fa522321",
    account_id="12345678",
)
print(response.id)

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