Skip to main content
POST
Send a mailbox message

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

Idempotency-Key
string

Client-chosen unique key to safely retry the request. Cached for 24h per (mailbox, endpoint, key). Different body with same key returns 409 idempotency_conflict.

Maximum string length: 255

Query Parameters

mailbox_id
string

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Body

application/json
attachments
object[]

Attachments to send with the message.

bcc
object[]

Hidden copied recipients.

Maximum array length: 50
cc
object[]

Visible copied recipients.

Maximum array length: 50
custom_headers
object

Custom X-* headers to include. Mailbox writes reject X-SES-TENANT, X-SES-CONFIGURATION-SET and X-SES-MESSAGE-TAGS case-insensitively.

from
object

Sender address. Defaults to mailbox identity.

html_body
string

HTML body.

reply_to
object[]

Reply-To recipients.

subject
string

Subject line; defaults to empty.

Maximum string length: 998
text_body
string

Plain text body.

to
object[]

Primary recipients. Supply 1 to 50 recipients in total across To, Cc and Bcc.

Maximum array length: 50

Response

Message queued

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required