Messages

Send Message

post/api/v1/mail/mailboxes/{email_address}/messages

Path parameters

email_addressstring required

Headers

Idempotency-Keystring nullable

Request body

subjectstring required
body_textstring nullable
body_htmlstring nullable
thread_idstring uuid nullable

Attach this message to an existing conversation. Preferred over in_reply_to_message_id when replying; pass the thread_id returned by the list/get endpoints.

in_reply_to_message_idstring nullable

Message-ID of the email being replied to

reply_tostring email nullable

Optional Reply-To address. If set, recipients' mail clients route replies here instead of the From mailbox.

track_opensboolean

Embed an open-tracking pixel in the HTML body. Requires body_html; a send with track_opens and no HTML body is rejected with 422. Opens surface as first_opened_at/open_count on the message. Note: tracking pixels can raise spam scores.

Response

Successful Response

idstring uuid required
mailbox_idstring uuid required
thread_idstring uuid nullable required
message_idstring nullable
from_addressstring required
to_addressesstring[] required
cc_addressesstring[] nullable required
subjectstring nullable required
snippetstring nullable required
direction'inbound' | 'outbound' required
status'queued' | 'sent' | 'delivered' | 'bounced' | 'failed' | 'received' | 'deleted' required
is_readboolean required
is_starredboolean required
has_attachmentsboolean required
reply_tostring nullable
first_opened_atstring date-time nullable
open_countinteger
created_atstring date-time required
updated_atstring date-time nullable
sending_domain_warningstring nullable
import_job_idstring uuid nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.