Command reference
deployments inbox-binding
Agent email inbox bindings
| Command | Summary |
|---|---|
deployments inbox-binding create | Bind an inbox to an agent deployment or external target |
deployments inbox-binding list | List inbox bindings |
deployments inbox-binding show | Show an inbox binding |
deployments inbox-binding delete | Delete an inbox binding |
deployments inbox-binding create
Bind an inbox to an agent deployment or external target.
deployments inbox-binding create <inbox> --binding-type <binding-type>- Calls
POST /v1/agent-email/inboxes/{inboxId}/bindings(SDKcreateAgentEmailBinding). - 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 |
|---|---|---|---|---|
<inbox> | positional | yes | Inbox ID | |
--binding-type | string | yes | platform_agent or external | |
--agent-deployment-id | string | Agent deployment ID for platform_agent bindings | ||
--external-id | string | External target ID for external bindings | ||
--metadata | string (json) | Binding metadata |
Also accepts the global flags.
deployments inbox-binding list
List inbox bindings.
deployments inbox-binding list <inbox>- Calls
GET /v1/agent-email/inboxes/{inboxId}/bindings(SDKlistAgentEmailBindings). - 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 | ||
<inbox> | positional | yes | Inbox ID |
Also accepts the global flags.
deployments inbox-binding show
Show an inbox binding.
deployments inbox-binding show <id>- Calls
GET /v1/agent-email/bindings/{bindingId}(SDKgetAgentEmailBinding). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments inbox-binding delete
Delete an inbox binding.
deployments inbox-binding delete <id>- Calls
DELETE /v1/agent-email/bindings/{bindingId}(SDKdeleteAgentEmailBinding). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - 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 |
Also accepts the global flags.