Sign inGet Started

bird preferences list

Usage

Codebeispiel
bird preferences list [flags]

Description

List the workspace's stated messaging preferences (consent grants and opt-outs) as a cursor page. Filter by channel, and by handle within a channel, to look up one person before messaging them.

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

Examples

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

Options

Filters

NameDescription
--brand-idReturn only this Brand's email preferences, including older preferences belonging to the original business. Omit to return all matching preferences. Empty, repeated or malformed values return 422. Where the endpoint also accepts a channel filter, it must be email. A Brand not found in this workspace returns 404.
--channelReturn only preferences on this channel. Known values: email, sms, whatsapp, amb (others may exist).
--handleReturn only preferences for this exact handle: an email address or an E.164 phone number. Requires channel, since a handle only means something on its channel.
--response-schemaPrint the fields this command returns, then exit

Pagination

NameDescription
--ending-beforeCursor 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. Allowed range: 1 to 100.
--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 preferences createRecord a preference
bird preferences deleteDelete a preference
bird preferences getGet a preference

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.