Skip to content
Cloudflare API
Start here
API Reference
Email Sending

Suppressions

List account Email Sending suppressions
email_sending.suppressions.list(SuppressionListParams**kwargs) -> SyncCursorPagination[SuppressionListResponse]
GET/accounts/{account_id}/email/sending/suppressions
Get account Email Sending suppression
email_sending.suppressions.get(strsuppression_id, SuppressionGetParams**kwargs) -> SuppressionGetResponse
GET/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Create account Email Sending suppression
email_sending.suppressions.create(SuppressionCreateParams**kwargs) -> SuppressionCreateResponse
POST/accounts/{account_id}/email/sending/suppressions
Update account Email Sending suppression
email_sending.suppressions.edit(strsuppression_id, SuppressionEditParams**kwargs) -> SuppressionEditResponse
PATCH/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Delete account Email Sending suppression
email_sending.suppressions.delete(strsuppression_id, SuppressionDeleteParams**kwargs) -> SuppressionDeleteResponse
DELETE/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Bulk import account Email Sending suppressions
email_sending.suppressions.import_(SuppressionImportParams**kwargs) -> SuppressionImportResponse
POST/accounts/{account_id}/email/sending/suppressions/bulk
ModelsExpand Collapse
class SuppressionListResponse: …
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]
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]
class SuppressionCreateResponse: …
id: str
formatuuid
class SuppressionEditResponse: …
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]
class SuppressionDeleteResponse: …
id: str
formatuuid
class SuppressionImportResponse: …
deduplicated: int
errors: int
invalid: int
items: List[Item]
index: int
status: Literal["processed", "invalid", "error", "skipped"]
One of the following:
"processed"
"invalid"
"error"
"skipped"
id: Optional[str]
formatuuid
email: Optional[str]
formatemail
error: Optional[str]
processed: int
skipped: int
total: int