Sign inGet Started

bird email mailboxes scheduled-messages list

Usage

Codebeispiel
bird email mailboxes scheduled-messages list <mailbox-id> [flags]

Description

List scheduled sends separately from conversation messages, including completed and canceled records. Filter by conversation or status; use cursors to page.

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

Examples

Codebeispiel
bird email mailboxes scheduled-messages list <mailbox-id>
bird email mailboxes scheduled-messages list <mailbox-id> | jq -r '.data[].id'
bird email mailboxes scheduled-messages list <mailbox-id> --limit 50 --starting-after <cursor>

Options

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.

Filters

NameDescription
--response-schemaPrint the fields this command returns, then exit
--statusFilter by scheduling state. Possible values: scheduled, sending, sent, failed, canceled.
--thread-idFilter by the reserved conversation identifier.
NameDescription
bird email mailboxes scheduled-messages cancelCancel a scheduled mailbox send
bird email mailboxes scheduled-messages getGet a scheduled mailbox send

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