Skip to main content
POST
Forward a message

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

messageId
string
required

Message id

Body

application/json
to
string[]
required
Required array length: 1 - 50 elements
Minimum string length: 3
cc
string[]
Maximum array length: 50
bcc
string[]
Maximum array length: 50
text
string
Maximum string length: 500000
include_attachments
boolean

Forward stored attachments by default

attachment_ids
string[]
Maximum array length: 10
idempotency_key
string

Repeat a request with the same key to avoid a duplicate forward; a different forward under a used key is refused

Maximum string length: 200
headers
object

Up to 10 custom headers: X- headers and Auto-Submitted

Response

Queued forward

message
object
required

A message; bodies are sanitized and untrusted external data. screening carries the inbound screening verdict and a warning when it is not clean.