Skip to main content

Send a transactional email

Transactional emails are one-to-one messages triggered by something a single subscriber did — an order receipt, a password reset, a shipping notice, a confirmation. Unlike a Broadcast, they aren't scheduled to a list; your application calls the API at the moment the event happens, and the platform renders and delivers one message.

Before you begin​

  • An API key or client credentials with permission to send. (Confirm how to generate and scope keys in your account.)
  • The API base URL and the send endpoint for your account (confirm the exact host and path in your account).
  • A transactional Edition saved as the template for this message, with personalization tokens for the parts that change per subscriber (name, order number, reset link).
  • The template's identifier so the API can reference it instead of sending raw HTML each time.

Steps​

  1. Build the template. Create an Edition for the message and author it like any other, inserting personalization tokens where per-subscriber values go. Save it in the Folder you use for transactional templates.
  2. Authenticate. Request an access token (or send your API key) using the credentials above. Send over HTTPS only.
  3. Call the send endpoint. POST a request identifying the template, the subscriber's email address, and a set of key/value pairs that fill each personalization token. Field names are account-specific — confirm the exact request schema in your account.
  4. Handle the response. A success response returns a message or send identifier; keep it for tracking. On a 4xx error, fix the request (bad token, unknown template, missing field) and retry; on a 5xx, retry with backoff.
  5. Respect suppression. Transactional sends still honor account-wide suppression. Confirm your critical messages are classed correctly so essential mail isn't held.

Result​

The subscriber receives the rendered message within moments, and the send appears in reporting with delivery and engagement metrics tied to the identifier you captured.

Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.