Command reference
deployments email-suppression
Agent email suppressions
| Command | Summary |
|---|---|
deployments email-suppression create | Create an email suppression |
deployments email-suppression list | List email suppressions |
deployments email-suppression remove | Remove an email suppression |
deployments email-suppression create
Create an email suppression.
deployments email-suppression create --address <address> --reason <reason>- Calls
POST /v1/agent-email/suppressions(SDKcreateAgentEmailSuppression). - 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 |
|---|---|---|---|---|
--address | string | yes | Suppressed email address | |
--reason | string | yes | manual or policy |
Also accepts the global flags.
deployments email-suppression list
List email suppressions.
deployments email-suppression list- Calls
GET /v1/agent-email/suppressions(SDKlistAgentEmailSuppressions). - 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-suppression remove
Remove an email suppression.
deployments email-suppression remove <id>- Calls
POST /v1/agent-email/suppressions/{suppressionId}/remove(SDKremoveAgentEmailSuppression). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - 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 |
Also accepts the global flags.