API ReferenceTransactional EmailSend Transactional Email

    Send Transactional Email

    Send reliable transactional emails like password resets, order confirmations, and system notifications with high delivery rates and real-time tracking.

    POSThttps://tapi.simplysend.email/send

    Parameters

    toRequired
    string
    Email address of the recipient.
    fromRequired
    string
    The sender email address (must be a verified domain). e.g. `"Acme Newsletters" <[email protected]>` or `[email protected]`
    subjectRequired
    string
    The subject line for the email.
    htmlRequired
    string
    HTML body content. Include required template variables. See below compliance template below.
    text
    string
    The plain text version of the email for clients that don't support HTML.
    replyTo
    string
    The email address where recipients' replies should be sent. e.g. `[email protected]` or `"Acme Support" <[email protected]>`
    attachments
    array

    An array of objects containing name, contentType, and base64 encoded content.

    Up to 10 attachments per email. Combined size cannot exceed 2MB.

    PDFPNGJPGCSVDOCX
    headers
    object

    Custom headers to include in the email. e.g. { "X-Entity-ID": "user_12345", "X-Feedback-ID": "transaction_abc" }

    Note: List-Unsubscribe is automatically injected by the system.

    templateVariables
    object

    Key-value pairs for dynamic content injection. e.g. { "first_name": "John", "discount_code": "WELCOME20" }

    These can be referenced in your HTML or text body using double curly braces, e.g. {{first_name}}.

    enableClickTracking
    boolean

    Wrap all links in the email with click-tracking redirect URLs so each click is recorded as an email_clicked event. Defaults to false.

    We recommend leaving click tracking disabled for transactional emails to minimize delivery latency and avoid link mismatch warnings.

    Optional custom link redirection tracking subdomain (typically [region]-t-link.yourdomain.com, e.g. us-t-link.yourdomain.com). If verified and configured, links in the email body will be wrapped using this custom subdomain. If not verified, click tracking will fall back to using the default Simply Send tracking domain. Custom link configuration is per domain.

    enableOpenTracking
    boolean

    Inject a 1x1 transparent tracking pixel to record Open events. Defaults to false.

    We recommend leaving open tracking disabled for transactional emails to avoid latency and spam-filter scrutiny.

    Idempotency-Key
    header string

    A unique UUID string used to make the request idempotent. If the system receives a duplicate request with the same key within a 24-hour window, it returns the cached original response without processing the email send again.

    Concurrent duplicate requests will return a 409 Conflict status.

    RequestPOST
    curl -X POST https://tapi.simplysend.email/send \
      -H "X-Api-Key: your_transactional_api_key" \
      -H "X-Id: your_account_id" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: your_unique_uuid" \
      -d '{
        "to": "[email protected]",
        "from": "sender@yourdomain.com",
        "subject": "Hello from Simply Send",
        "html": "<html><body><h1>Hello!</h1><p>Test email.</p><br><br><p>{{company_address_html}}</p><p>{{unsubscribe_email_html}}</p><p>{{report_abuse_email_html}}</p></body></html>",
        "text": "Hello! Test email."
      }'
    {
      "success": true,
      "data": {
        "message": "Email sent successfully",
        "messageId": "0100019a3908b26b-fdaeb60d-bf18-4154-91fd-1552ca877eeb-000000",
        "from": "sender@yourdomain.com",
        "totalRecipients": 1,
        "recipients": [
          {
            "email": "[email protected]",
            "status": "sent",
            "role": "to"
          }
        ],
        "status": "sent"
      }
    }

    Compliance Templates