Send email
Create one EmailSend from either a saved email template or rendered JSX Email content and enqueue delivery. Rendered content must include a request subject.
Authorizations
Unified API key for server-side SDK and API integrations
Headers
Required idempotency key. Reusing it with the same request replays the original send; reusing it with a different request returns 409.
1 - 255Body
Advanced fallback saved Email Template id to snapshot and render. Prefer templateKey for SDK integrations.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Stable developer key for the saved Email Template.
1 - 120Rendered content. Mutually exclusive with templateId and templateKey.
Purpose for rendered content. Required for rendered content. transactional sends do not receive a marketing footer; marketing and newsletter sends receive Segmentflow compliance automatically. Saved template sends continue to use the saved Template purpose.
transactional, marketing, newsletter Optional primary recipient Profile id. When to.email is absent, the Profile canonical email is used for delivery.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Optional SenderProfile override. Must be compatible with the Email Template purpose policy.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Optional sender override. Accepts a bare email or "Name email@example.com" and must match a verified SenderProfile email.
1 - 320Optional reply-to override. Accepts a single bare email or "Name email@example.com" and must use a verified sender domain owned by the organization.
1 - 320Final subject for rendered sends, or an optional override for saved Template sends. When omitted for a saved Template send, the Template subject is frozen onto the EmailSend.
1 - 998SubscriptionGroup gate. Required for marketing-class Email Template purposes; if supplied, the send is skipped when the recipient is not subscribed according to the group's OptIn/OptOut policy.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Recipient identity. This identifies or creates a Profile but does not update durable Profile Properties.
Visible copied recipients. Persisted and handed to the email provider.
1 - 320Hidden copied recipients. Persisted for retry/provider handoff but never returned by public responses.
1 - 320One-send email payload exposed to templates under /data/*.
Per-send tracking preferences.
Response
Default Response
EmailSend id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Lifecycle status for an EmailSend.
Queued, Processing, Sent, Failed, Skipped, DeliveryUnknown Source saved Template id. Null when the send was created from rendered JSX Email content.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Content source used to create this EmailSend. Rendered sends never create fake Templates.
- EmailSendTemplateSource
- EmailSendRenderedSource
Immutable Email Instance rendered for this send.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$SenderProfile used for the send.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Frozen sender envelope used for provider handoff.
Frozen reply-to envelope used for provider handoff.
Frozen subject used for provider handoff.
SubscriptionGroup gate used for the send, if supplied.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Organization-scoped recipient Profile id.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Redacted-safe recipient handle returned by the API.
Visible copied recipients returned for operational visibility.
Underlying Message id after worker processing creates one.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Reason delivery was intentionally skipped before provider send.
ProfileErased, ProfileSuppressed, ProfileUnsubscribed, MissingRecipientEmail, InvalidTemplate, InvalidSenderProfile, SendAdmissionBlocked, RateLimited Reason delivery failed after a send was accepted for processing.
WorkerFailed, ProviderRejected, RenderFailed, Unknown Operational failure message suitable for logs and support.
Send creation timestamp.
Last send update timestamp.

