Get account Email Sending suppression

email_sending.suppressions.get(, ) -> SuppressionGetResponse

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

Gets an Email Sending suppression owned by the account.

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

suppression_id: str

formatuuid

ReturnsExpand Collapse

class SuppressionGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

email: str

formatemail

expires_at: Optional[datetime]

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

note: Optional[str]

Get 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
)
suppression = client.email_sending.suppressions.get(
    suppression_id="396a5436-d4b0-42a6-b3fc-48e8fa522321",
    account_id="54442216",
)
print(suppression.id)

{
  "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"
  },
  "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"
  },
  "success": true
}