Deployments.ai Docs
Command reference

deployments email-placement

Agent email regional placements

CommandSummary
deployments email-placement createCreate an email placement
deployments email-placement listList email placements
deployments email-placement showShow an email placement
deployments email-placement updateUpdate an email placement

deployments email-placement create

Create an email placement.

deployments email-placement create --name <name> --region <region>
  • Calls POST /v1/agent-email/placements (SDK createAgentEmailPlacement).
  • 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
--namestringyesResource name
--regionstringyesPrimary AWS region
--secondary-regionstringSecondary AWS region
--dedicated-poolbooleanUse a dedicated IP pool
--is-defaultbooleanMake this the default placement

Also accepts the global flags.

deployments email-placement list

List email placements.

deployments email-placement list
  • Calls GET /v1/agent-email/placements (SDK listAgentEmailPlacements).
  • 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 email-placement show

Show an email placement.

deployments email-placement show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments email-placement update

Update an email placement.

deployments email-placement update <id>
  • Calls PATCH /v1/agent-email/placements/{placementId} (SDK updateAgentEmailPlacement).
  • 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
--namestringPlacement name
--statusstringactive or disabled
--dedicated-poolbooleanUse a dedicated IP pool
--is-defaultbooleanMake this the default placement

Also accepts the global flags.

On this page