Deployments.ai Docs
Command reference

deployments inbox-binding

Agent email inbox bindings

CommandSummary
deployments inbox-binding createBind an inbox to an agent deployment or external target
deployments inbox-binding listList inbox bindings
deployments inbox-binding showShow an inbox binding
deployments inbox-binding deleteDelete 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>
FlagTypeRequiredDefaultDescription
<inbox>positionalyesInbox ID
--binding-typestringyesplatform_agent or external
--agent-deployment-idstringAgent deployment ID for platform_agent bindings
--external-idstringExternal target ID for external bindings
--metadatastring (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 (SDK listAgentEmailBindings).
  • 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
<inbox>positionalyesInbox ID

Also accepts the global flags.

deployments inbox-binding show

Show an inbox binding.

deployments inbox-binding show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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} (SDK deleteAgentEmailBinding).
  • 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