Documentation › Advanced

Transactional Email

6 min read

Aledamail's transactional email module lets you send triggered, one-to-one emails via API — receipts, password resets, order confirmations, account notifications, and any other email your application needs to send in response to user actions.

Unlike marketing campaigns (which go to a list), transactional emails go to a single recipient at a time and are triggered by your application code. They use the same sending infrastructure as your campaigns, so there is nothing extra to configure.

When to use transactional email

Note: Transactional emails bypass unsubscribe suppression — they are sent even if the recipient has unsubscribed from your marketing list. Use this only for genuinely transactional messages that the recipient needs to receive regardless of their marketing preferences.

Getting your API key

  1. Go to Settings → API in your Aledamail dashboard.
  2. Copy your API key. Keep this secret — it grants full access to your account.

Sending a transactional email

Send a POST request to the transactional email endpoint with your message content:

POST https://mxa.aledamail.com/api/tx/v1/send Authorization: Bearer YOUR_API_KEY Content-Type: application/json { "to": "customer@example.com", "to_name": "Jane Smith", "subject": "Your order has shipped", "from_email": "orders@yourcompany.com", "from_name": "Your Company", "html": "<p>Hi Jane, your order #1234 has shipped...</p>", "plain": "Hi Jane, your order #1234 has shipped..." }

Response

{ "success": true, "message_id": "abc123xyz", "queued_at": "2026-09-09T10:30:00Z" }

Using templates

For emails you send frequently — like password resets or order confirmations — create a template in the portal and reference it by ID in your API call. This lets you update the email design without changing your application code.

POST https://mxa.aledamail.com/api/tx/v1/send Authorization: Bearer YOUR_API_KEY Content-Type: application/json { "to": "customer@example.com", "template_id": "tmpl_abc123", "variables": { "first_name": "Jane", "order_number": "1234", "tracking_url": "https://track.example.com/abc" } }

In your template, use {{first_name}}, {{order_number}}, etc. as placeholders. They are replaced with your variable values before sending.

Creating a template

  1. Go to Transactional → Templates in your dashboard.
  2. Click New Template.
  3. Give it a name and design the email using the builder or paste raw HTML.
  4. Add variables using {{variable_name}} syntax anywhere in the subject or body.
  5. Save the template and copy its ID for use in your API calls.
Screenshot: The transactional email template editor showing a password reset template with variable placeholders highlighted

Tracking delivery

Every transactional send is logged. Go to Transactional → Logs to see delivery status, open events, and any errors. You can filter by recipient, template, date range, or status.

You can also query the status of a specific send via the API:

GET https://mxa.aledamail.com/api/tx/v1/messages/abc123xyz Authorization: Bearer YOUR_API_KEY

Rate limits

Transactional email sends are processed immediately and prioritised over campaign sends. There is no hard rate limit for transactional sends, but burst sending above 100 per second may be queued briefly to protect your sending reputation.