Agent Email
Update an email draft
PATCH /v1/agent-email/drafts/{draftId} · SDK updateAgentEmailDraft · CLI deployments draft update
PATCH
Requires agent-email:write.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
draftId*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
bcc?array<>Items
items <= 50cc?array<>Items
items <= 50html?stringmetadata?scheduledAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timesubject?stringLength
length <= 998text?stringto?array<>Items
items <= 50AgentEmailDraftResponse
application/json- response
approvedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timebccAddresses*array<>Items
items <= 50ccAddresses*array<>Items
items <= 50clientId?stringcreatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timefailureReason?stringhtmlBody?stringid*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$inboxId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$metadata*organizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$rejectedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timereplyToMessageId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$scheduledAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timesentMessageId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$status*stringValue in
"approved""cancelled""draft""failed""pending_approval""queued""rejected""scheduled""sent"subject*stringtextBody?stringtoAddresses*array<>Items
items <= 50updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -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"}