Skip to main content
POST
Send Email

Request

Headers

string
Optional client-generated key (UUIDv4 recommended). When present, the gateway deduplicates retries within a 24-hour window and returns the original response. Strongly recommended for all send operations so that network retries never produce duplicate messages.

Body Parameters

string | array
required
Recipient email address, or an array of addresses. RFC 5322 addresses are accepted (e.g. "Jane Doe <jane@example.com>").
string
required
Email subject line. Maximum 998 characters per RFC 2822, but 150 characters is strongly recommended for deliverability.
string
HTML-formatted message body. Either body_html or body_text is required. When both are supplied, the email is sent as a multipart/alternative message and clients select the best representation.
string
Plain-text message body. Either body_html or body_text is required.
array
Optional array of carbon-copy recipients.
array
Optional array of blind carbon-copy recipients.
string
Optional Reply-To address. Defaults to the sending mailbox when omitted.
string
Optional contact UUID. When supplied, the message is linked to the contact’s timeline automatically.
string
Optional deal UUID. When supplied, the message is logged against the deal.
string
Optional thread identifier to reply into an existing conversation. When omitted, a new thread is created.
array
Optional array of attachments. Each entry accepts filename, mime_type, and either content_base64 or storage_path.

Response

object
Every response also carries standard rate-limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID for support traceability.

Example Response

Errors