Deployments.ai Docs
Command reference

deployments email-policy

Agent email sending policy

CommandSummary
deployments email-policy showShow the email policy
deployments email-policy updateUpdate the email policy

deployments email-policy show

Show the email policy.

deployments email-policy show

Also accepts the global flags.

deployments email-policy update

Update the email policy.

deployments email-policy update
  • Calls PATCH /v1/agent-email/policy (SDK updateAgentEmailPolicy).
  • 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
--allowliststring (a,b,c)Warmup-approved recipient addresses
--blockliststring (a,b,c)Blocked recipient addresses
--daily-outbound-message-limitstring (number)Daily outbound message limit
--max-attachment-bytesstring (number)Maximum attachment bytes
--max-recipients-per-messagestring (number)Maximum recipients per message
--raw-retention-daysstring (number)Raw message retention days
--bounce-rate-threshold-basis-pointsstring (number)Bounce threshold in basis points
--complaint-rate-threshold-basis-pointsstring (number)Complaint threshold in basis points
--sending-statusstringactive or paused
--warmup-stagestringsandbox, ramp_1, ramp_2, ramp_3, or production

Also accepts the global flags.

On this page