Skip to main content
POST
Forward Email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

email_id
string
required

Body

application/json

Request to forward an existing email — creates a DRAFT, does not send.

to
string<email>[]

Recipient addresses.

cc
string<email>[]
bcc
string<email>[]
note
string | null

Optional prefatory note rendered above the forwarded chain.

subject
string | null

Override subject. Defaults to source subject prefixed with Fwd: .

email_sender_id
string | null

Optional outgoing sender. When omitted, picks the source's shared inbox if applicable, else the user's default sender. Mirrors reply.

Response

Successful Response

Email summary for inbox list rows.

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
subject
string | null
required
snippet
string | null
required
from
string | null
required
to
string[]
required
cc
string[]
required

List of CC email addresses

direction
enum<string>
required

The request direction of the email. Either inbound or outbound

Available options:
inbound,
outbound
status
enum<string>
required
Available options:
draft,
pending,
sending,
sent,
error
sent_at
string<date-time> | null
required

When the email was sent.

is_unread
boolean
required
object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.