Suppressions

List account Email Sending suppressions

client.emailSending.suppressions.list(, ?): CursorPagination<SuppressionListResponse { id, created_at, email, 5 more } >

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

Get account Email Sending suppression

client.emailSending.suppressions.get(, , ?): SuppressionGetResponse { id, created_at, email, 5 more }

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

Create account Email Sending suppression

client.emailSending.suppressions.create(, ?): SuppressionCreateResponse { id, scope }

POST/accounts/{account_id}/email/sending/suppressions

Update account Email Sending suppression

client.emailSending.suppressions.edit(, , ?): SuppressionEditResponse { id, created_at, email, 5 more }

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

Delete account Email Sending suppression

client.emailSending.suppressions.delete(, , ?): SuppressionDeleteResponse { id, scope }

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

Bulk import account Email Sending suppressions

client.emailSending.suppressions.import(, ?): SuppressionImportResponse { deduplicated, errors, invalid, 4 more }

POST/accounts/{account_id}/email/sending/suppressions/bulk

ModelsExpand Collapse

SuppressionListResponse { 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 | null

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?: string | null

Advisory note for this suppression, if any.

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

SuppressionGetResponse { 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 | null

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?: string | null

Advisory note for this suppression, if any.

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

SuppressionCreateResponse { id, scope }

id: string

The suppression’s identifier.

formatuuid

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

SuppressionEditResponse { 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 | null

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?: string | null

Advisory note for this suppression, if any.

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

SuppressionDeleteResponse { id, scope }

id: string

The suppression’s identifier.

formatuuid

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

SuppressionImportResponse { deduplicated, errors, invalid, 4 more }

deduplicated: number

Number of items dropped because their email address and scope repeated an earlier item in this request. Counted once and excluded from items.

errors: number

Number of items that failed to import due to an unexpected error.

invalid: number

Number of items with an invalid email address or sending domain.

items: Array<Item>

Per-item results, in the same order as the request body.

index: number

Zero-based index of this item in the request body.

status: "processed" | "invalid" | "error" | "skipped"

Outcome for this item.

One of the following:

"processed"

"invalid"

"error"

"skipped"

id?: string

The created or promoted suppression’s identifier. Present when status is processed.

formatuuid

email?: string

The submitted email address for this item.

formatemail

error?: string

Human-readable error message. Present when status is invalid, error, or skipped.

scope?: Type { type } | UnionMember1 { 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 { type }

type: "account"

Blocks the recipient for every sending domain of the account.

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

processed: number

Number of items successfully created or promoted.

skipped: number

Number of items skipped because the existing suppression is not customer-managed (for example, a read-only policy suppression).

total: number

Total number of items in the request body, including duplicates.