Skip to main content
POST
Send email message

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of send_email_message.

email_account_sid
string
required

The mailbox that sends; it must be active and not paused.

Required string length: 18
Pattern: ^em_ac_
reply_to_email_message_sid
string | null

Reply to this message of the same mailbox: subject, In-Reply-To and the thread are set for you, and to defaults to its sender.

Required string length: 18
Pattern: ^em_ms_
forward_email_message_sid
string | null

Forward this message of the same mailbox: the quoted original goes under your body; to is required. Never with reply_to_email_message_sid.

Required string length: 18
Pattern: ^em_ms_
include_original_attachments
boolean | null

With a forward: carry its attachments. Default true.

to
object[] | null

Required unless it is a reply. At most 50 recipients across to, cc and bcc.

Maximum array length: 50
cc
object[] | null
Maximum array length: 50
bcc
object[] | null
Maximum array length: 50
from_email
string<email> | null

The mailbox's address or one of its aliases; anything else is 409 send_as_denied. Default: the address.

Maximum string length: 320
subject
string | null

Required unless it is a reply or a forward.

Maximum string length: 1023
body_html
string | null

Exactly one of body_html and body_text.

body_text
string | null
attachments
object[] | null

Bytes, or a stored attachment by reference. 20 MB in total.

include_signature
boolean | null

Append the mailbox's signature. Default true.

scheduled_at
string | null

ISO 8601 UTC, in the future: queue it for then. Absent: send now. A past time is refused.

client_reference
string | null

Your key of this message, echoed in every webhook about it. With the recipients it is one message: sent once.

Maximum string length: 255
idempotency_key
string | null

Dedup key for 24 hours: a repeat is answered by the earlier send; the same key with another payload is 409 idempotency_key_reused.

Maximum string length: 255
confirmed_not_sent
string | null

A person's word that the attempt named here (activity_log_sid of a send in doubt) never arrived: the message goes out again.

Required string length: 18
Pattern: ^em_al_
confirmed_sent
string | null

A person's word that the attempt named here arrived: it is settled sent and nothing is sent. Never with confirmed_not_sent.

Required string length: 18
Pattern: ^em_al_
override_suppression
boolean | null

Send to addresses on the stop-list anyway. Requires can_manage_email_suppressions; each one is audited.

track_opens
boolean | null

Default: the mailbox's setting. true needs a verified tracking domain.

track_clicks
boolean | null
custom_headers
object[] | null

X-* headers, List-Unsubscribe or Reply-To; any other name is refused.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required
async
enum<boolean>

Present when the message was queued (scheduled_at).

Available options:
true
pending
object[]

Queued only: what to wait for.