bird email suppressions list
Usage
Codevoorbeeld
bird email suppressions list [flags]Description
List the workspace's email suppressions as a cursor page. A suppression blocks delivery to an address. The email parameter filters by prefix, so compare the complete addresses you get back before treating one as a match.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Codevoorbeeld
bird email suppressions list
bird email suppressions list | jq -r '.data[].id'
bird email suppressions list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| 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. The filter returns legacy records until they are moved to messaging preferences. - 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. |
Pagination
| Name | Description |
|---|---|
| --ending-before | Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. |
| --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. |
Related
| Name | Description |
|---|---|
| bird email suppressions add | Create an email suppression |
| bird email suppressions get | Get an email suppression |
| bird email suppressions remove | Delete an email suppression |
Gerelateerde bronnen
Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.
Bekijk de gidsWhat happens when someone opts outBegrijp het conceptWhat is one-click unsubscribe, and how do I implement List-Unsubscribe?Ontdek de mogelijkheidEmail opt-outsVolg het leerpadOperate messaging reliably
Ontvang een implementatieoverzicht