Skip to main content
POST
Forward inbox message

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Path Parameters

id
number
required

Message identifier

Example:

1

Body

application/json
toEmails
string<email>[]
required

Who the message is forwarded to: one address or more.

Example:
mailboxId
number

Mailbox to send the forward from; it must belong to the user and be active. Defaults to the mailbox that holds the message.

Example:

1

ccEmails
string<email>[]

Copied on the forward.

Example:
bccEmails
string<email>[]

Copied on the forward, unseen by the other recipients.

Example:
note
string

A note placed above the forwarded message.

Maximum string length: 5000
Example:

"Jane asked about pricing; can you take this?"

Response

Inbox message forwarded successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Inbox message forwarded successfully"

data
object
required