Skip to main content
POST
email.template.send

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 returned by email.template.create.

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

Sender on your verified domain.

to
object
required

One primary recipient, personal data sent for delivery.

autoSubmitted
enum<string>

Mark automatic mail so recipients can prevent reply loops.

Available options:
auto-generated,
auto-replied
inReplyTo
string

RFC Message-ID of the parent message.

Maximum string length: 998
Pattern: ^<[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+(?:\.[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*>$
references
string[]

Thread history: at most 20 RFC Message-IDs and 4,096 bytes.

Maximum array length: 20
Maximum string length: 998
Pattern: ^<[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+(?:\.[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*>$
cc
object[]

Copy recipients; total to, cc and bcc is at most 50.

Maximum array length: 49
bcc
object[]

Blind copy recipients; included in the total of 50.

Maximum array length: 49
replyTo
object[]

Reply-to addresses.

Maximum array length: 10
variables
object

Case-sensitive template variables, at most 50 bounded strings.

validateBeforeSend
boolean
default:false

Whether to pay for address validation before sending.

handlebars
boolean
default:false

Whether to expand the template with the requested template syntax.

attachments
object[]

Uploaded attachments, at most 6 MB combined.

Maximum array length: 10

Response

The result

status
string
required

Accepted for delivery; not a delivery receipt.

Allowed value: "queued"
acceptance
enum<string>

Confirmed acceptance or confirmed queueing; neither proves delivery.

Available options:
accepted,
queued
rfcMessageId
string

Final RFC Message-ID when confirmed, distinct from the message reference.

Maximum string length: 998
Pattern: ^<[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+(?:\.[A-Za-z0-9!#$%&'*+\-/=?^_`{|}~]+)*@[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?(?:\.[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)*>$
ref
string

Reference to what this call created. Pass it as ref to email.status when delivery correlation is available.