Skip to content
DevelopersTerminal

Inbox CLI reference


List and resolve durable approvals and decisions.

On this page

Use this page to inspect every public atoi inbox command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.

atoi inboxList and resolve durable approvals and decisions.

CommandWhat it does
atoi inbox listList decisions that need attention.
atoi inbox approveApprove one exact Inbox request.
atoi inbox denyDeny one exact Inbox request.
atoi inbox snoozeHide an Inbox item until a future time.

#inbox list

List decisions that need attention.

atoi inbox list [--status <status>] [--limit <n>]

FlagTypeDefaultValuesWhat it does
--statusstringFilter by Inbox status.
--limitnumberLimit the number of returned records.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run inbox list

bash
atoi inbox list --status unread --json

#inbox approve

Approve one exact Inbox request.

atoi inbox approve <item-id> [--item <item-id>] [--request <request-id>] --confirm

FlagTypeDefaultValuesWhat it does
--itemstringSelect an Inbox item by id instead of a positional id.
--requeststringBind the decision to an exact approval request id.
--confirm requiredbooleanConfirm the exact consequential action after you inspect its target.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run inbox approve

bash
atoi inbox approve inb_4d6p --request req_2n8s --confirm --json

#inbox deny

Deny one exact Inbox request.

atoi inbox deny <item-id> [--item <item-id>] [--request <request-id>] --confirm

FlagTypeDefaultValuesWhat it does
--itemstringSelect an Inbox item by id instead of a positional id.
--requeststringBind the decision to an exact approval request id.
--confirm requiredbooleanConfirm the exact consequential action after you inspect its target.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run inbox deny

bash
atoi inbox deny inb_4d6p --request req_2n8s --confirm --json

#inbox snooze

Hide an Inbox item until a future time.

atoi inbox snooze <item-id> [--item <item-id>] [--until <timestamp-ms> | --hours <hours>]

FlagTypeDefaultValuesWhat it does
--itemstringSelect an Inbox item by id instead of a positional id.
--untilnumberSet the future Unix timestamp in milliseconds.
--hoursnumber3Snooze for this many hours.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run inbox snooze

bash
atoi inbox snooze inb_4d6p --hours 4 --json

Was this useful?