bird email suppressions list

Usage

Code example

bird email suppressions list [flags]

List the workspace's email suppressions, which block delivery to an address, as a cursor page.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Code example

bird email suppressions list
bird email suppressions list | jq -r '.data[].id'
bird email suppressions list --limit 50 --starting-after <cursor>

Name	Description
--email	Case-insensitive prefix filter on the address. Returns every suppression whose address starts with this value. A full address finds that address's records, while a fragment such as alice finds every address beginning with it. The same address can match several records, one per suppression reason.
--reason	Return only suppressions with this reason: - hard_bounce: Delivery permanently failed. - complaint: The recipient reported a message as spam. - unsubscribe: The recipient opted out. Deprecated: unsubscribes are now recorded as messaging preferences rather than suppressions, so no new records carry this reason and existing ones are being moved. Expect this value to match nothing. - manual: Added through the API or dashboard. Possible values: hard_bounce, complaint, unsubscribe, manual.
--response-schema	Print the fields this command returns, then exit
--scope-type	Return only suppressions with this scope. Every suppression is workspace-wide, so workspace returns all of them without narrowing the results. The other five values, category, audience, topic, contact and domain, always come back with an empty page. Possible values: workspace, category, audience, topic, contact, domain.

Name	Description
--ending-before	Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>	Maximum number of items to return per page.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Name	Description
bird email suppressions remove	Delete a suppression