Command reference
deployments email-tenant
Platform sending tenants
| Command | Summary |
|---|---|
deployments email-tenant create | Create a sending tenant |
deployments email-tenant list | List sending tenants |
deployments email-tenant get | Get a sending tenant |
deployments email-tenant update | Update 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(SDKcreateEmailTenant). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Resource name |
Also accepts the global flags.
deployments email-tenant list
List sending tenants.
deployments email-tenant list- Calls
GET /v1/email/tenants(SDKlistEmailTenants). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size |
Also accepts the global flags.
deployments email-tenant get
Get a sending tenant.
deployments email-tenant get <id>- Calls
GET /v1/email/tenants/{tenantId}(SDKgetEmailTenant). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource 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}(SDKupdateEmailTenant). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | Tenant name | ||
--status | string | active or paused |
Also accepts the global flags.