Deployments.ai Docs
Command reference

deployments email-tenant

Platform sending tenants

CommandSummary
deployments email-tenant createCreate a sending tenant
deployments email-tenant listList sending tenants
deployments email-tenant getGet a sending tenant
deployments email-tenant updateUpdate or explicitly pause/reinstate a sending tenant

deployments email-tenant create

Create a sending tenant.

deployments email-tenant create --name <name>
  • Calls POST /v1/email/tenants (SDK createEmailTenant).
  • 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

Also accepts the global flags.

deployments email-tenant list

List sending tenants.

deployments email-tenant list
  • Calls GET /v1/email/tenants (SDK listEmailTenants).
  • 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-tenant get

Get a sending tenant.

deployments email-tenant get <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments email-tenant update

Update or explicitly pause/reinstate a sending tenant.

deployments email-tenant update <id>
  • Calls PATCH /v1/email/tenants/{tenantId} (SDK updateEmailTenant).
  • 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
--namestringTenant name
--statusstringactive or paused

Also accepts the global flags.

On this page