Skip to main content
POST
email.message.append

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

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
enum<string>
required

Connected mailbox app.

Available options:
gmail,
outlook
ref
string
required

Owned destination folder reference from email.folders.list.

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

RFC 5322 MIME bytes encoded as standard base64, at most 10 MiB. This saves a message; it does not send it.

Required string length: 4 - 13981016
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Response

The result

status
string
required

The mailbox confirmed the stored message.

Allowed value: "saved"
ref
string

Reference to what this call created. Pass it as ref to email.message.get.