Command reference
deployments inbox-domain
Custom sending and receiving domains
| Command | Summary |
|---|---|
deployments inbox-domain create | Register a custom email domain |
deployments inbox-domain list | List email domains |
deployments inbox-domain show | Show DNS and verification state |
deployments inbox-domain refresh | Refresh email domain verification |
deployments inbox-domain revoke | Revoke a custom email domain |
deployments inbox-domain create
Register a custom email domain.
deployments inbox-domain create --domain <domain>- Calls
POST /v1/agent-email/domains(SDKcreateAgentEmailDomain). - 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 |
|---|---|---|---|---|
--domain | string | yes | Domain name | |
--placement-id | string | Email placement ID |
Also accepts the global flags.
deployments inbox-domain list
List email domains.
deployments inbox-domain list- Calls
GET /v1/agent-email/domains(SDKlistAgentEmailDomains). - 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 |
Also accepts the global flags.
deployments inbox-domain show
Show DNS and verification state.
deployments inbox-domain show <id>- Calls
GET /v1/agent-email/domains/{domainId}(SDKgetAgentEmailDomain). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments inbox-domain refresh
Refresh email domain verification.
deployments inbox-domain refresh <id>- Calls
POST /v1/agent-email/domains/{domainId}/refresh(SDKrefreshAgentEmailDomain). - 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 |
Also accepts the global flags.
deployments inbox-domain revoke
Revoke a custom email domain.
deployments inbox-domain revoke <id>- Calls
POST /v1/agent-email/domains/{domainId}/revoke(SDKrevokeAgentEmailDomain). - 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.