Skip to content

Mail

mail_suppression_add

Manually suppress a recipient address (reason is always "manual"); idempotent

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

NameTypeRequiredDescription
notestringOptional free-text note
addressstringEmail address to suppress

Response

FieldTypeAlwaysDescription
idstring
notestring
reasonstring
addressstring
created_atstring
source_event_idstring

Try it

Manually suppress a recipient address (reason is always "manual"); idempotent.

When to use

Manually suppress a recipient address (reason is always "manual"); idempotent

Example

Ask your agent something like this:

Manually suppress a recipient address (reason is always "manual"); idempotent.

The agent will invoke mail_suppression_add with these arguments:

{
  "address": "<address>"
}

Esc

Start typing to search the docs.

navigateselect