Skip to main content
POST
email.draft.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref the draft's create returned.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
to
string[] | null

Recipient addresses. Send null to clear the list.

Maximum array length: 50
Required string length: 1 - 320
cc
string[] | null

Copy recipients. Send null to clear the list.

Maximum array length: 50
Required string length: 1 - 320
bcc
string[] | null

Hidden copy recipients. Send null to clear the list.

Maximum array length: 50
Required string length: 1 - 320
subject
string | null

Subject line. Send null to clear it.

Required string length: 1 - 998
text
string | null

Plain-text body. Send null to clear it.

Required string length: 1 - 1000000
html
string | null

HTML body. Send null to clear it.

Required string length: 1 - 1000000
replyTo
string[] | null

Addresses replies go to. Send null to clear the list.

Maximum array length: 50
Required string length: 1 - 320
addAttachments
object[]

Files to add to the draft, base64-encoded. Attachments combined must stay under 6 MB.

Maximum array length: 10
removeAttachments
string[]

Ids of attachments to remove; the ids are on the draft row.

Maximum array length: 10
Required string length: 1 - 255
addLabels
string[]

Labels to add to the draft.

Maximum array length: 20

A label, up to 64 characters, e.g. awaiting-reply.

Required string length: 1 - 64
removeLabels
string[]

Labels to remove from the draft.

Maximum array length: 20

A label, up to 64 characters, e.g. awaiting-reply.

Required string length: 1 - 64
sendAt
string | null

Schedule the draft to be sent at this ISO 8601 instant (UTC). Send null to cancel a scheduled send. The send counts against the daily sending limit when it is scheduled (a new time counts again); to stop one already scheduled, clear sendAt, delete the draft, or pause the inbox.

Maximum string length: 40

Response

The result

inbox
string
required

The inbox address the draft is written from.

to
string[]
required

Recipient addresses, empty when cleared.

cc
string[]

Copy recipients.

bcc
string[]

Hidden copy recipients.

replyTo
string[]

Addresses replies go to.

subject
string

Subject line.

text
string

Sanitised plain-text body.

html
string

HTML body.

labels
string[]

Labels on the draft.

attachments
object[]

Attachments, metadata only.

inReplyTo
string

RFC Message-ID this draft replies to, when it is a reply draft.

forwardOf
string

RFC Message-ID this draft forwards, when it is a forward draft.

sendAt
string

When the draft is scheduled to be sent, ISO 8601.

sendStatus
enum<string>

State of a scheduled send.

Available options:
scheduled,
sending,
failed
updatedAt
string

When the draft was last changed, ISO 8601.