Command reference
deployments inbox
Agent email inboxes
| Command | Summary |
|---|---|
deployments inbox create | Create an agent email inbox |
deployments inbox list | List agent email inboxes |
deployments inbox show | Show an agent email inbox |
deployments inbox update | Update an agent email inbox |
deployments inbox messages | List inbox messages |
deployments inbox search | Search inbox messages |
deployments inbox send | Send an agent email message |
deployments inbox threads | List inbox threads |
deployments inbox drafts | List inbox drafts |
deployments inbox create
Create an agent email inbox.
deployments inbox create- Calls
POST /v1/agent-email/inboxes(SDKcreateAgentEmailInbox). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--local-part | string | Requested address local part | ||
--domain-id | string | Verified email domain ID | ||
--client-id | string | External client ID | ||
--name | string | Inbox name | ||
--metadata | string (json) | Inbox metadata |
Also accepts the global flags.
deployments inbox list
List agent email inboxes.
deployments inbox list- Calls
GET /v1/agent-email/inboxes(SDKlistAgentEmailInboxes). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--status | string | Inbox status | ||
--client-id | string | External client ID |
Also accepts the global flags.
deployments inbox show
Show an agent email inbox.
deployments inbox show <id>- Calls
GET /v1/agent-email/inboxes/{inboxId}(SDKgetAgentEmailInbox). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments inbox update
Update an agent email inbox.
deployments inbox update <id>- Calls
PATCH /v1/agent-email/inboxes/{inboxId}(SDKupdateAgentEmailInbox). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | Inbox name | ||
--status | string | active, paused, or archived | ||
--metadata | string (json) | Inbox metadata |
Also accepts the global flags.
deployments inbox messages
List inbox messages.
deployments inbox messages <id>- Calls
GET /v1/agent-email/inboxes/{inboxId}/messages(SDKlistAgentEmailMessages). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID | |
--direction | string | inbound or outbound | ||
--status | string | Message status |
Also accepts the global flags.
deployments inbox search
Search inbox messages.
deployments inbox search <id>- Calls
POST /v1/agent-email/inboxes/{inboxId}/messages/search(SDKsearchAgentEmailMessages). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID | |
--query | string | Full-text search query | ||
--from | string | Sender address | ||
--to | string | Recipient address | ||
--participants | string (a,b,c) | Participant addresses | ||
--direction | string | inbound or outbound | ||
--status | string | Message status | ||
--has-attachments | boolean | Only messages with attachments |
Also accepts the global flags.
deployments inbox send
Send an agent email message.
deployments inbox send <id> --to <a-b-c> --subject <subject>- Calls
POST /v1/agent-email/inboxes/{inboxId}/messages(SDKsendAgentEmailMessage). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--to | string (a,b,c) | yes | Recipient addresses | |
--cc | string (a,b,c) | CC addresses | ||
--bcc | string (a,b,c) | BCC addresses | ||
--subject | string | yes | Message subject | |
--text | string | Plain-text body | ||
--html | string | HTML body | ||
--attachments | string (json) | Attachment payloads | ||
--scheduled-at | string | Scheduled send timestamp | ||
--client-id | string | External client ID |
Also accepts the global flags.
deployments inbox threads
List inbox threads.
deployments inbox threads <id>- Calls
GET /v1/agent-email/inboxes/{inboxId}/threads(SDKlistAgentEmailThreads). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments inbox drafts
List inbox drafts.
deployments inbox drafts <id>- Calls
GET /v1/agent-email/inboxes/{inboxId}/drafts(SDKlistAgentEmailDrafts). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID | |
--status | string | Draft status |
Also accepts the global flags.