Command reference
deployments email-policy
Agent email sending policy
| Command | Summary |
|---|---|
deployments email-policy show | Show the email policy |
deployments email-policy update | Update the email policy |
deployments email-policy show
Show the email policy.
deployments email-policy show- Calls
GET /v1/agent-email/policy(SDKgetAgentEmailPolicy). - Needs an environment:
--envor the saved context.
Also accepts the global flags.
deployments email-policy update
Update the email policy.
deployments email-policy update- Calls
PATCH /v1/agent-email/policy(SDKupdateAgentEmailPolicy). - 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 |
|---|---|---|---|---|
--allowlist | string (a,b,c) | Warmup-approved recipient addresses | ||
--blocklist | string (a,b,c) | Blocked recipient addresses | ||
--daily-outbound-message-limit | string (number) | Daily outbound message limit | ||
--max-attachment-bytes | string (number) | Maximum attachment bytes | ||
--max-recipients-per-message | string (number) | Maximum recipients per message | ||
--raw-retention-days | string (number) | Raw message retention days | ||
--bounce-rate-threshold-basis-points | string (number) | Bounce threshold in basis points | ||
--complaint-rate-threshold-basis-points | string (number) | Complaint threshold in basis points | ||
--sending-status | string | active or paused | ||
--warmup-stage | string | sandbox, ramp_1, ramp_2, ramp_3, or production |
Also accepts the global flags.