Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

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

Path Parameters

inboxId
string
required

Inbox id

Body

application/json
to
string[]
required

Recipient addresses, optionally as 'Name '

Required array length: 1 - 50 elements
Minimum string length: 3
subject
string
required
Required string length: 1 - 998
cc
string[]
Maximum array length: 50
bcc
string[]
Maximum array length: 50
text
string

Plain-text body (recommended)

Maximum string length: 500000
html
string

HTML body; sanitized before sending

Maximum string length: 500000
idempotency_key
string

Repeat a request with the same key to avoid duplicate sends

Maximum string length: 200
attachment_ids
string[]
Maximum array length: 10
Minimum string length: 1
draft_id
string

Delete this draft atomically when the message is queued

Minimum string length: 1
draft_updated_at
string<date-time>

With draft_id: the draft's updated_at as you read it. Sending is refused (409) when it was saved again since

reply_to
string[]

Reply-To addresses, so replies go elsewhere than this inbox

Maximum array length: 5
Minimum string length: 3
headers
object

Up to 10 custom headers: X- headers, for example a ticket id, and Auto-Submitted (auto-generated, auto-replied, auto-notified or no) to mark automated mail

labels
string[]

Labels for the new conversation, e.g. ['billing', 'tenant:acme']

Maximum array length: 20
Maximum string length: 40

Response

Queued message

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.