Deployments.ai Docs
Command reference

deployments inbox-domain

Custom sending and receiving domains

CommandSummary
deployments inbox-domain createRegister a custom email domain
deployments inbox-domain listList email domains
deployments inbox-domain showShow DNS and verification state
deployments inbox-domain refreshRefresh email domain verification
deployments inbox-domain revokeRevoke 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 (SDK createAgentEmailDomain).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--domainstringyesDomain name
--placement-idstringEmail placement ID

Also accepts the global flags.

deployments inbox-domain list

List email domains.

deployments inbox-domain list
  • Calls GET /v1/agent-email/domains (SDK listAgentEmailDomains).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments inbox-domain show

Show DNS and verification state.

deployments inbox-domain show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments inbox-domain refresh

Refresh email domain verification.

deployments inbox-domain refresh <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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 (SDK revokeAgentEmailDomain).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page