Forward Thread Email
Forward a message in an inbox thread to new recipients.
POST
Forwards a message from the inbox address.
The attachments of the original message are sent with the forward, together
with any
attachments you add. The request fails when they exceed 25 MB of
content in total. An original
attachment that was sent from a URL (path) cannot be forwarded, and the
request returns a 422.
The forward carries the same In-Reply-To and References headers as a
reply to the original message, so
mail clients may group it with the original conversation. These headers can’t
be set or overridden.
Path Parameters
Body Parameters
string | string[]
required
Recipient email address. For multiple addresses, send as an array of strings.
Must name at least one address.
to, cc, and bcc combined cannot exceed
50 recipients.string | string[]
CC recipient email address.
string | string[]
BCC recipient email address.
string
An HTML note sent above the quoted original.
string
A plain-text note sent above the quoted original.
string
The subject of the forward. Max 2000 characters.
array
Files to attach, as on Send Email.
object
Custom headers to add to the email.
Headers
string
Add an idempotency key to prevent duplicated emails.
- Should be unique per API request
- Idempotency keys expire after 24 hours
- Have a maximum length of 256 characters
- A retry with the same key returns the first successful response, with the
idempotent-replayed: trueheader - A failed request is not stored, so you can retry it with the same key
- Reusing the key with a different body, or while the first request is still
running, returns a
409
Response Fields
string
The ID of the sent email. Use it with the emails
endpoints.