Documentation
Sign inGet started

bird email suppressions list

Usage

Contoh kode
bird email suppressions list [flags]

Description

List the workspace's email suppressions (addresses Bird will not deliver to) as a cursor page.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

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

Options

Filters

NameDescription
--emailCase-insensitive prefix filter on the address: returns every suppression whose address starts with this value, so a full address finds that address's records and a fragment such as alice finds every address beginning with it. The same address can match several records, one per suppression reason.
--reasonReturn only suppressions with this reason: hard_bounce (delivery permanently failed), complaint (the recipient reported a message as spam), unsubscribe (the recipient opted out), or manual (added through the API or dashboard).
--response-schemaPrint the fields this command returns, then exit
--scope-typeFilter by scope type. Suppressions are currently always workspace-scoped; the other values are reserved for future use.

Pagination

NameDescription
--ending-beforeCursor 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-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird email suppressions removeRemove a suppression