Skip to content

SDK method

suppressions.add

POST /suppressions

add an address to the suppression list.

Signature

ts
add(input: AddSuppressionRequest): Promise<Suppression>

Parameters

NameTypeRequiredDescription
addressstringyes—
reasonSuppressionReasonno—
scopestring | nullno—
notestring | nullno—

Returns

Promise<Suppression>

Example

ts
await tinbox.suppressions.add({ address: "bounce@example.com", reason: "bounce" });