Deployments.ai Docs
Agent Email

Update an email draft

PATCH /v1/agent-email/drafts/{draftId} · SDK updateAgentEmailDraft · CLI deployments draft update

PATCH
/v1/agent-email/drafts/{draftId}

Requires agent-email:write.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

draftId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Request Body

application/json
  1. body
bcc?array<>
Itemsitems <= 50
cc?array<>
Itemsitems <= 50
html?string
metadata?
scheduledAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
subject?string
Lengthlength <= 998
text?string
to?array<>
Itemsitems <= 50

Response Body

AgentEmailDraftResponse

application/json
  1. response
approvedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
bccAddresses*array<>
Itemsitems <= 50
ccAddresses*array<>
Itemsitems <= 50
clientId?string
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
failureReason?string
htmlBody?string
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
inboxId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
metadata*
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
rejectedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
replyToMessageId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
scheduledAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
sentMessageId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
status*string
Value in"approved""cancelled""draft""failed""pending_approval""queued""rejected""scheduled""sent"
subject*string
textBody?string
toAddresses*array<>
Itemsitems <= 50
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
curl -X PATCH "https://example.com/v1/agent-email/drafts/string" \  -H "x-deployments-environment: string" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "approvedAt": "2019-08-24T14:15:22Z",  "bccAddresses": [    "string"  ],  "ccAddresses": [    "string"  ],  "clientId": "string",  "createdAt": "2019-08-24T14:15:22Z",  "failureReason": "string",  "htmlBody": "string",  "id": "string",  "inboxId": "string",  "metadata": {    "property1": null,    "property2": null  },  "organizationId": "string",  "rejectedAt": "2019-08-24T14:15:22Z",  "replyToMessageId": "string",  "scheduledAt": "2019-08-24T14:15:22Z",  "sentMessageId": "string",  "status": "approved",  "subject": "string",  "textBody": "string",  "toAddresses": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z"}