Skip to main content
POST
email.message.forward

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 that holds the message and sends the forward.

Required string length: 1 - 320
to
required

to

Required string length: 1 - 320
ref
string

The ref a send, reply or draft-send returned. Preferred over messageId.

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

The source message's public RFC Message-ID, e.g. abc@example.com.

Required string length: 1 - 998
cc

Copy recipients.

Required string length: 1 - 320
bcc

Hidden copy recipients.

Required string length: 1 - 320
subject
string

Subject for the forward. Left out, the source subject is kept.

Required string length: 1 - 998
text
string

A comment to add above the forwarded message.

Required string length: 1 - 1000000
html
string

HTML comment above the forwarded message.

Required string length: 1 - 1000000
replyTo
string

Address replies go to instead of the inbox.

Required string length: 1 - 320
attachments
object[]

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

Maximum array length: 10

Response

The result

status
enum<string>
required

Whether the forward was accepted for delivery.

Available options:
sent
messageId
string
required

The forwarded message's public RFC Message-ID.

ref
string

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