Tool
mail_suppression_add
Manually suppress a recipient address (reason is always "manual"); idempotent
Manually suppress a recipient address (reason is always "manual"); idempotent
Behavior
- HTTP
POST /mail/suppressions
Arguments
Name | Type | Required | Description |
|---|---|---|---|
note | string | — | Optional free-text note explaining why the address was suppressed |
address | string | • | Email address to suppress, e.g. "user@example.com"; matched case-insensitively |
Response
Field | Type | Always | Description |
|---|---|---|---|
id | string | • | Suppression entry id |
note | string | • | Free-text note recorded when the entry was added by hand; null otherwise |
reason | string | • | Why the address is suppressed: hard_bounce and complaint come from SES feedback, unsubscribe from the recipient, manual from mail_suppression_add |
address | string | • | The suppressed recipient address, lowercased and trimmed |
created_at | string | • | When the address was suppressed (ISO 8601 UTC) |
source_event_id | string | • | Id of the email event that caused the suppression; null for a manual entry |
Try it
Manually suppress a recipient address (reason is always "manual"); idempotent.