Deployments.ai Docs
Command reference

deployments inbox

Agent email inboxes

CommandSummary
deployments inbox createCreate an agent email inbox
deployments inbox listList agent email inboxes
deployments inbox showShow an agent email inbox
deployments inbox updateUpdate an agent email inbox
deployments inbox messagesList inbox messages
deployments inbox searchSearch inbox messages
deployments inbox sendSend an agent email message
deployments inbox threadsList inbox threads
deployments inbox draftsList inbox drafts

deployments inbox create

Create an agent email inbox.

deployments inbox create
  • Calls POST /v1/agent-email/inboxes (SDK createAgentEmailInbox).
  • 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
--local-partstringRequested address local part
--domain-idstringVerified email domain ID
--client-idstringExternal client ID
--namestringInbox name
--metadatastring (json)Inbox metadata

Also accepts the global flags.

deployments inbox list

List agent email inboxes.

deployments inbox list
  • Calls GET /v1/agent-email/inboxes (SDK listAgentEmailInboxes).
  • 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
--statusstringInbox status
--client-idstringExternal client ID

Also accepts the global flags.

deployments inbox show

Show an agent email inbox.

deployments inbox show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource 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} (SDK updateAgentEmailInbox).
  • 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
<id>positionalyesResource ID
--namestringInbox name
--statusstringactive, paused, or archived
--metadatastring (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 (SDK listAgentEmailMessages).
  • 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
<id>positionalyesResource ID
--directionstringinbound or outbound
--statusstringMessage status

Also accepts the global flags.

Search inbox messages.

deployments inbox search <id>
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
<id>positionalyesResource ID
--querystringFull-text search query
--fromstringSender address
--tostringRecipient address
--participantsstring (a,b,c)Participant addresses
--directionstringinbound or outbound
--statusstringMessage status
--has-attachmentsbooleanOnly 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>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--tostring (a,b,c)yesRecipient addresses
--ccstring (a,b,c)CC addresses
--bccstring (a,b,c)BCC addresses
--subjectstringyesMessage subject
--textstringPlain-text body
--htmlstringHTML body
--attachmentsstring (json)Attachment payloads
--scheduled-atstringScheduled send timestamp
--client-idstringExternal 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 (SDK listAgentEmailThreads).
  • 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
<id>positionalyesResource ID

Also accepts the global flags.

deployments inbox drafts

List inbox drafts.

deployments inbox drafts <id>
  • Calls GET /v1/agent-email/inboxes/{inboxId}/drafts (SDK listAgentEmailDrafts).
  • 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
<id>positionalyesResource ID
--statusstringDraft status

Also accepts the global flags.

On this page