Skip to main content
POST
email.draft.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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 returned by email.draft.create or email.drafts.list.

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

Response

The result

inbox
string
required

The inbox address the draft is written from.

to
string[]

Recipients, when supplied.

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.

preview
string

Short preview.

createdAt
string

Creation time in UTC.