Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

inbox_id
string<uuid>
required

Email inbox UUID.

message_id
string<uuid>
required

Inbound email message UUID.

Body

application/json
to
required

One recipient or a non-empty recipient array. Each recipient may be an email string or an object with email and optional name.

Minimum string length: 3
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
cc

One recipient or a recipient array. Each recipient may be an email string or an object with email and optional name.

Minimum string length: 3
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
bcc

One recipient or a recipient array. Each recipient may be an email string or an object with email and optional name.

Minimum string length: 3
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
text
string

Optional plain-text note prepended to the generated forwarded-message block. Blank values are treated as omitted.

html
string

Optional HTML note prepended to the generated forwarded-message block. Blank values are treated as omitted.

Response

Forward accepted by the standard email send pipeline.

data
object
required
suppressed
object[]

Recipients removed by suppression checks when at least one recipient remains and the message is accepted.