Skip to main content
POST
email.draft.create

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
inbox
string
required

The inbox address the draft is written from.

Required string length: 1 - 320
to
string[]

Recipient addresses.

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

Copy recipients.

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

Hidden copy recipients.

Maximum array length: 50
Required string length: 1 - 320
replyTo
string

Address replies go to instead of the inbox.

Required string length: 1 - 320
subject
string

Subject line.

Required string length: 1 - 998
text
string

Plain-text body. Send text, html or both.

Required string length: 1 - 1000000
html
string

HTML body. Send text, html or both.

Required string length: 1 - 1000000
attachments
object[]

Files to attach, base64-encoded. Attachments combined must stay under 6 MB.

Maximum array length: 10

Response

The result

inbox
string
required

The inbox address the draft is written from.

to
string[]
required

Recipient addresses.

cc
string[]
required

Copy recipients.

bcc
string[]
required

Hidden copy recipients.

replyTo
string

Address replies go to.

subject
string

Subject line.

text
string

Plain-text body.

html
string

HTML body.

ref
string

Reference to what this call created. Pass it as ref to email.draft.send.