API Reference

Welcome to the Lumail.io API documentation. Our REST API allows you to integrate email marketing capabilities into your applications.

Getting Started

Before using the API, you'll need to:

1. Generate an API token
2. Include the token in your requests using the Authorization header

Available Endpoints

Transactional Emails

• Send Emails - Send transactional emails to subscribers
• Verify Email - Verify email addresses before sending

Email Content Formats

• Send Email in Markdown - Plain text with Markdown formatting
• Send Email in HTML - Raw HTML emails
• Send Email in Tiptap - Tiptap JSON format

Subscriber Management

• Create Subscriber - Add new subscribers
• Get Subscribers - Retrieve subscriber list
• Update Subscriber - Update subscriber data
• Delete Subscriber - Remove subscribers

Subscriber Tags

• Add Tags to Subscriber - Apply tags to subscribers
• Remove Tags from Subscriber - Remove tags from subscribers

Events

Track and retrieve subscriber activity. Learn more about all event types.

• Track Events - Record new subscriber events
• Get Subscriber Events - Retrieve event history for a subscriber

Tags

• Get Tags - Retrieve tags
• Create Tags - Create new tags

Authentication

All API requests require authentication using a Bearer token:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.lumail.io/v1/endpoint

Rate Limits

API requests are rate-limited per organization. See Rate Limits for full details.

Plan	Requests per Minute
Free	100
Premium	700
Enterprise	2,000

Tutorials

Step-by-step guides for common API integrations:

• Create API Token - Generate tokens for API access
• V0 Capture Page - Build capture forms with API
• Dynamic Promo Codes - Personalized coupons via webhooks

Related Documentation

• Features - Platform features and capabilities
• Workflows - Automate email sequences
• Integrations - Connect with ClickFunnels, SystemIO, and more
• Email Domains - Configure verified sending domains