API Reference

Email Sending

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Suppressions

List account Email Sending suppressions

client.emailSending.suppressions.list(SuppressionListParams { account_id, cursor, email, 3 more } params, RequestOptionsoptions?): CursorPagination<SuppressionListResponse { id, created_at, email, 4 more } >

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

Get account Email Sending suppression

client.emailSending.suppressions.get(stringsuppressionID, SuppressionGetParams { account_id } params, RequestOptionsoptions?): SuppressionGetResponse { id, created_at, email, 4 more }

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

Create account Email Sending suppression

client.emailSending.suppressions.create(SuppressionCreateParams { account_id, email, expires_at, note } params, RequestOptionsoptions?): SuppressionCreateResponse { id }

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

Update account Email Sending suppression

client.emailSending.suppressions.edit(stringsuppressionID, SuppressionEditParams { account_id, expires_at, note } params, RequestOptionsoptions?): SuppressionEditResponse { id, created_at, email, 4 more }

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

Delete account Email Sending suppression

client.emailSending.suppressions.delete(stringsuppressionID, SuppressionDeleteParams { account_id } params, RequestOptionsoptions?): SuppressionDeleteResponse { id }

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

Bulk import account Email Sending suppressions

client.emailSending.suppressions.import(SuppressionImportParams { account_id, items } params, RequestOptionsoptions?): SuppressionImportResponse { deduplicated, errors, invalid, 4 more }

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

ModelsExpand Collapse

SuppressionListResponse { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string | null

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

SuppressionGetResponse { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string | null

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

SuppressionCreateResponse { id }

id: string

formatuuid

SuppressionEditResponse { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string | null

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

SuppressionDeleteResponse { id }

id: string

formatuuid

SuppressionImportResponse { deduplicated, errors, invalid, 4 more }

deduplicated: number

errors: number

invalid: number

items: Array<Item>

index: number

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

One of the following:

"processed"

"invalid"

"error"

"skipped"

id?: string

formatuuid

email?: string

formatemail

error?: string

processed: number

skipped: number

total: number