List Suppressions
postmark.list_suppressions
ActionEmailconnection required
Calls the Postmark API with the connection's credentials.
Read the do-not-send list for a message stream, optionally filtered by reason, origin, address or date.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Postmark
- Secret shape
- the server API token, or {"server_token": "…"}
- Config it needs
- message_stream, from_address, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
message_stream The message stream to read suppressions from. Leave blank to use the stream on the connection, which defaults to Postmark's 'outbound' stream. | string | No | — | — | — |
reason Only suppressions with this reason. | string | No | — | one of "HardBounce", "SpamComplaint", "ManualSuppression" | — |
origin Where the suppression came from: Recipient for an unsubscribe, Customer for one added through the API, Admin for Postmark itself. | string | No | — | one of "Recipient", "Customer", "Admin" | — |
email_address Only the suppression for this exact address. | string | No | — | email format | — |
fromdate Only records from this date/time onward, as 2021-01-01 or 2021-01-01T12:00:00. Postmark interprets it in US Eastern time. | string | No | — | — | — |
todate Only records up to this date/time, as 2021-01-01 or 2021-01-01T12:00:00. Postmark interprets it in US Eastern time. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The suppressions, each with EmailAddress, SuppressionReason, Origin and CreatedAt. | array | — |
count How many suppressions were returned. | number | — |
{
"count": 0,
"items": []
}See List Suppressions run in a workflow.
In a technical demo we add the Postmark connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.