List suppressed addresses
list_suppressionsView addresses this account will not send to and why each is suppressed, including bounce, complaint, or manual origin; pass an email to inspect one row.
Instructions
Purpose: see which addresses this account will not send to, and why each one is on the list. Pass an email to read that one row, including its id. NOT for: a general contact list (list_contacts). Returns: each row with its id, address, level, origin (bounce, complaint or manual), source_id, stream, and platform. platform true means the row applies to every account. Filter with origin when you only want one of those three.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_suppressions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Read one address instead of listing. | ||
| limit | No | Page size (1-100). | |
| cursor | No | next_cursor from the previous page. Omit for the first page. | |
| origin | No | Only rows from bounce, complaint or manual. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | This page of rows. | |
| error | No | Present instead of the fields above when the call was refused: code, message, fix, docs_url, retryable and, when waiting helps, retry_after_seconds. | |
| has_more | No | True when another page follows. | |
| next_cursor | No | Pass back as cursor for the next page; null on the last page. |