Skip to main content
The inbox commands let you triage the unified social inbox from the terminal: list conversations, read message threads, mark them read/resolved, reply with text and media, toggle inbox subscriptions per account, and manage reusable saved replies.
All commands accept the global flags: --json (default) / --table, --verbose, --api-key <key>, and --api-url <url>. You can also set SOME_API_KEY and SOME_API_URL in your environment.

Conversations

inbox:list

List inbox conversations.
The API endpoint (GET /v1/inbox/conversations) only paginates — every other filter (--status, --platform, --type, --read, --unread, --search) is applied client-side to the current page. Increase --limit if you need filters to span more conversations.
Examples

inbox:messages

Get messages in a conversation thread.
string
required
Thread ID of the conversation whose messages you want to fetch.
Examples

inbox:read

Mark a conversation as read (sets isSeen: true).
string
required
Thread ID of the conversation to mark as read.
Examples

inbox:resolve

Mark a conversation as resolved, unresolved, or archived.
string
required
Thread ID of the conversation to update.
Examples

inbox:delete

Delete one or more conversations. Prompts for confirmation unless --yes is passed. Each thread is deleted individually, and partial failures are reported.
string[]
required
One or more thread IDs to delete (space-separated).
Examples

Replies

inbox:reply

Reply to a conversation with text, files, or both. At least one of --message, --image, --video, --audio, or --file is required. Media flags are sent as typed attachments (image, video, audio, document).
string
required
Thread ID of the conversation to reply to.
Examples

Subscriptions

These commands accept either an account ID (UUID) or a platform name (e.g. twitter, facebook). When a platform name matches multiple connected accounts, the CLI prompts you to pick one. If no matching account exists, inbox:subscribe / inbox:unsubscribe exit successfully with a hint to connect one first.

inbox:subscribe

Enable inbox for a social account so it starts receiving messages, comments, and mentions.
string
required
Account ID (UUID) or platform name (twitter, facebook, etc.).
Examples

inbox:unsubscribe

Disable inbox for a social account.
string
required
Account ID (UUID) or platform name (twitter, facebook, etc.).
Examples

inbox:enable

Alias for inbox:subscribe.
string
required
Account ID (UUID) or platform name.
Example

inbox:disable

Alias for inbox:unsubscribe.
string
required
Account ID (UUID) or platform name.
Example

Saved Replies

Saved replies are reusable response templates you can attach files to and pull into the inbox.

inbox:saved-replies

List all saved replies, or get a single saved reply by ID.
string
Optional saved reply ID. When provided, returns details for that single reply; otherwise lists all saved replies.
Examples

inbox:create-reply

Create a saved reply with text, files, or both. At least one of --text or --file is required.
Examples

inbox:edit-reply

Edit a saved reply. At least one of --text or --file is required.
string
required
Saved reply ID to update.
Examples

inbox:delete-reply

Delete one or more saved replies. Prompts for confirmation unless --yes is passed. Each reply is deleted individually, and partial failures are reported.
string[]
required
One or more saved reply IDs to delete (space-separated).
Examples