Deployments.ai Docs
Command reference

deployments email-suppression

Agent email suppressions

CommandSummary
deployments email-suppression createCreate an email suppression
deployments email-suppression listList email suppressions
deployments email-suppression removeRemove 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 (SDK createAgentEmailSuppression).
  • 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
--addressstringyesSuppressed email address
--reasonstringyesmanual or policy

Also accepts the global flags.

deployments email-suppression list

List email suppressions.

deployments email-suppression list
  • Calls GET /v1/agent-email/suppressions (SDK listAgentEmailSuppressions).
  • 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-suppression remove

Remove an email suppression.

deployments email-suppression remove <id>
  • Calls POST /v1/agent-email/suppressions/{suppressionId}/remove (SDK removeAgentEmailSuppression).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

On this page