Send Transactional Email

Tracking Options

Set tracking.links: false to keep original URLs without shortening or tracking. This is useful for transactional emails where you don't want links like https://example.com/reset to become https://lumail.io/l/abc123.

Open and click tracking can process personal data. For confirmation, authentication, and other necessary messages where tracking is not required, explicitly set both options to false.

Subscriber creation and double opt-in

When to does not match an existing subscriber, Lumail creates one before queuing the email:

• By default the subscriber is created as TRANSACTIONAL (not marketing-eligible, still receives transactional mail).
• If Add transactional recipients to the marketing list is on, the subscriber is created as SUBSCRIBED. Double opt-in is ignored.
• Existing contacts keep their current status. Blocked addresses (BANNED, BOUNCED, COMPLAINED) are rejected.

The transactional API does not generate or expose the native Lumail confirmation token. Adding a tag after your own confirmation does not change Lumail's subscription status or populate confirmedAt and confirmationIp. Use the Subscribers API with Lumail's native double opt-in for the supported confirmation lifecycle, or manage consent and marketing eligibility entirely in your own system.

Response

• Success (200 OK) - Email queued successfully for sending
• Error (400 Bad Request) - Invalid request data
• Error (401 Unauthorized) - Invalid or missing API token
• Error (404 Not Found) - Subscriber not found

Response Fields

Content Types

Choose the format that best fits your use case:

See detailed documentation for each format:

• Send Email in Markdown
• Send Email in HTML
• Send Email in Tiptap

Email Content Format

The content field uses Markdown format. You can include various elements:

Basic Text

Hello {{name}}, this is a basic email.

Formatted Text

This is **bold text** and this is _italic text_.

Headings and Lists

# Welcome {{name}}!

## Benefits

- First benefit
- Second benefit
- Third benefit

### Getting Started

1. Step one
2. Step two
3. Step three

Links and Images

Visit our [website](https://example.com) for more information.

![Company Logo](https://example.com/logo.png)

Variable Substitution

You can use variables in your email content that will be automatically replaced with subscriber data:

• {{name}} - Subscriber's name
• {{email}} - Subscriber's email address
• {{phone}} - Subscriber's phone number
• {{unsubscribeUrl}} - Automatic unsubscribe link
• {{customField}} - Any custom field defined for the subscriber

Domain Verification

The from email address domain must be verified in your account. The API will:

1. Extract the domain from the from email address
2. Verify the domain is authorized and verified for your organization
3. Reject the request if the domain is not verified

Email Tracking

Transactional emails automatically include:

• Open tracking - Pixel tracking to detect email opens
• Click tracking - Link wrapping for click tracking
• Unsubscribe links - Automatic unsubscribe functionality
• Email storage - All sent emails are stored for analytics

Rate Limiting

Emails are queued and sent at a controlled rate to ensure deliverability:

• Rate: 40 emails per second per delivery lane
• Parallelism: 40 concurrent sends per delivery lane
• Combined QStash dispatch: up to 80 emails per second when both priority and bulk lanes are saturated
• Priority queue: Transactional and manually triggered emails use the priority lane
• Bulk queue: Campaign, workflow campaign, and newsletter batches use the bulk lane
• Queue: Emails are processed through QStash for reliability

Usage Examples

Welcome Email

Perfect for onboarding new users:

{
  "to": "[email protected]",
  "subject": "Welcome to {{companyName}}!",
  "content": "# Welcome {{name}}!\n\nThanks for joining us. Get started by exploring your dashboard.\n\n## Next Steps\n\n- Complete your profile\n- Explore our features\n- Join our community\n\nWe're excited to have you on board!",
  "from": "[email protected]",
  "preview": "Welcome to the platform"
}

Order Confirmation

For e-commerce order confirmations:

{
  "to": "[email protected]",
  "subject": "Order Confirmation #{{orderNumber}}",
  "content": "## Thanks for your order, {{name}}!\n\nYour order #{{orderNumber}} has been confirmed and will be processed shortly.\n\n### Order Details\n\n- Order Number: {{orderNumber}}\n- Total: {{orderTotal}}\n- Shipping Address: {{shippingAddress}}\n\n**Estimated Delivery:** {{deliveryDate}}\n\nIf you have any questions, please don't hesitate to contact our support team.",
  "from": "[email protected]",
  "replyTo": "[email protected]"
}

Password Reset

For password reset notifications:

{
  "to": "[email protected]",
  "subject": "Password Reset Request",
  "content": "Hi {{name}},\n\nYou requested a password reset for your account. Click the link below to reset your password:\n\n[Reset Password]({{resetUrl}})\n\n**This link will expire in 24 hours.**\n\nIf you didn't request this reset, please ignore this email or contact our support team if you have concerns.\n\nStay secure!",
  "from": "[email protected]"
}

Error Handling

Common error responses:

Invalid Email Address

{
  "message": "Invalid email format"
}

Unauthorized Domain

{
  "message": "Domain 'example.com' is not authorized or verified for this organization"
}

Invalid Email Format

{
  "message": "Invalid from email address"
}

Validation Error

{
  "message": "Validation failed",
  "errors": [
    {
      "field": "subject",
      "message": "Subject is required"
    }
  ]
}

Related Documentation

• Variables - Personalize emails with subscriber data
• Content Deliverability Checker - Optimize emails before sending
• Email Domains Setup - Configure verified sending domains
• API Tokens - Generate API tokens for authentication
• Create Subscriber - Add subscribers to send emails to