Skip to content
Start here

Suppressions

List account Email Sending suppressions
GET/accounts/{account_id}/email/sending/suppressions
Get account Email Sending suppression
GET/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Create account Email Sending suppression
POST/accounts/{account_id}/email/sending/suppressions
Update account Email Sending suppression
PATCH/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Delete account Email Sending suppression
DELETE/accounts/{account_id}/email/sending/suppressions/{suppression_id}
Bulk import account Email Sending suppressions
POST/accounts/{account_id}/email/sending/suppressions/bulk
ModelsExpand Collapse
SuppressionListResponse object { id, created_at, email, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
email: string
formatemail
expires_at: string
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
note: optional string
SuppressionGetResponse object { id, created_at, email, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
email: string
formatemail
expires_at: string
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
note: optional string
SuppressionCreateResponse object { id }
id: string
formatuuid
SuppressionEditResponse object { id, created_at, email, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
email: string
formatemail
expires_at: string
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
note: optional string
SuppressionDeleteResponse object { id }
id: string
formatuuid
SuppressionImportResponse object { deduplicated, errors, invalid, 4 more }
deduplicated: number
errors: number
invalid: number
items: array of object { index, status, id, 2 more }
index: number
status: "processed" or "invalid" or "error" or "skipped"
One of the following:
"processed"
"invalid"
"error"
"skipped"
id: optional string
formatuuid
email: optional string
formatemail
error: optional string
processed: number
skipped: number
total: number