Skip to content

Mail

mail_suppression_list

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)

Tool

mail_suppression_list

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)

Behavior

HTTP
GET /mail/suppressions

Arguments

NameTypeRequiredDescription
qstringCase-insensitive substring match on address
limitintegerMax items per page (1–100, default 50)
cursorstringOpaque pagination cursor from a prior page
reasonstringFilter by reason

Response

FieldTypeAlwaysDescription
itemsarray
next_cursorstring

Try it

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring).

When to use

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)

Example

Ask your agent something like this:

List suppressed recipient addresses for the current product (paginated, filter by reason or address substring).

The agent will invoke mail_suppression_list with these arguments:

{}

Esc

Start typing to search the docs.

navigateselect