Command reference
deployments draft
Agent email drafts
| Command | Summary |
|---|---|
deployments draft create | Create an email draft |
deployments draft show | Show an email draft |
deployments draft update | Update an email draft |
deployments draft submit | Submit an email draft for approval |
deployments draft approve | Approve an email draft |
deployments draft reject | Reject an email draft |
deployments draft cancel | Cancel an email draft |
deployments draft send | Send an approved email draft |
deployments draft create
Create an email draft.
deployments draft create <inbox> --to <a-b-c> --subject <subject>- Calls
POST /v1/agent-email/inboxes/{inboxId}/drafts(SDKcreateAgentEmailDraft). - 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 |
|---|---|---|---|---|
<inbox> | positional | yes | Inbox ID | |
--to | string (a,b,c) | yes | Recipient addresses | |
--cc | string (a,b,c) | CC addresses | ||
--bcc | string (a,b,c) | BCC addresses | ||
--subject | string | yes | Message subject | |
--text | string | Plain-text body | ||
--html | string | HTML body | ||
--reply-to-message-id | string | Message ID being replied to | ||
--scheduled-at | string | Scheduled send timestamp | ||
--metadata | string (json) | Draft metadata |
Also accepts the global flags.
deployments draft show
Show an email draft.
deployments draft show <id>- Calls
GET /v1/agent-email/drafts/{draftId}(SDKgetAgentEmailDraft). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments draft update
Update an email draft.
deployments draft update <id>- Calls
PATCH /v1/agent-email/drafts/{draftId}(SDKupdateAgentEmailDraft). - 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 | |
--to | string (a,b,c) | Recipient addresses | ||
--cc | string (a,b,c) | CC addresses | ||
--bcc | string (a,b,c) | BCC addresses | ||
--subject | string | Message subject | ||
--text | string | Plain-text body | ||
--html | string | HTML body | ||
--scheduled-at | string | Scheduled send timestamp | ||
--metadata | string (json) | Draft metadata |
Also accepts the global flags.
deployments draft submit
Submit an email draft for approval.
deployments draft submit <id>- Calls
POST /v1/agent-email/drafts/{draftId}/submit(SDKsubmitAgentEmailDraft). - 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 |
Also accepts the global flags.
deployments draft approve
Approve an email draft.
deployments draft approve <id>- Calls
POST /v1/agent-email/drafts/{draftId}/approve(SDKapproveAgentEmailDraft). - 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 |
Also accepts the global flags.
deployments draft reject
Reject an email draft.
deployments draft reject <id> --reason <reason>- Calls
POST /v1/agent-email/drafts/{draftId}/reject(SDKrejectAgentEmailDraft). - 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 | |
--reason | string | yes | Rejection reason |
Also accepts the global flags.
deployments draft cancel
Cancel an email draft.
deployments draft cancel <id>- Calls
POST /v1/agent-email/drafts/{draftId}/cancel(SDKcancelAgentEmailDraft). - 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.
deployments draft send
Send an approved email draft.
deployments draft send <id>- Calls
POST /v1/agent-email/drafts/{draftId}/send(SDKsendAgentEmailDraft). - 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 |
Also accepts the global flags.