Lumail
Product
Agents
PricingDocsChangelog
Log inSign up
IntroductionTutorialsAI IntegrationSDKAPI ReferenceIntegrationsFeaturesDeliverabilityWorkflows

Privacy & GDPR

GDPR in LumailData Processing Agreement (DPA) Status

Ship with Email

Choose an Email MCP for Claude Code, Then Ship the LaunchSend a Newsletter from Cursor, Then Ship the LaunchMove a Launch List from Kit Without Paying for Dormant Subscribers

Tutorials

Create an API TokenSend Transactional Email with SMTPSend React Email Templates with LumailBuild a V0 Capture PageDynamic Promo Codes with Webhooks

AI Integration

Claude Code (Plugin)Codex (Plugin)ChatGPT PluginHermesSkills (CLI)OpenClawCursor (MCP)TypeScript SDK IntegrationsTools API (v2)Examples & Recipes

SDK

SDK IntroductionSDK ConfigurationSDK ResourcesSDK ToolsErrors and Retries

API Reference

API TokensTypeScript SDKCLIMCP ServerTools API (v2)Admin Tools APIRate LimitsSMTP EndpointPOSTSend Transactional EmailPOSTSend Email in HTMLPOSTSend Email in MarkdownPOSTSend Email in TiptapPOSTEmail Verification APIPOSTCreate SubscriberGETGet SubscriberPATCHUpdate SubscriberPOSTUnsubscribe SubscriberPOSTAdd Tags to SubscriberDELETERemove Tags from SubscriberPOSTTrack EventGETGet Subscriber EventsGETGet All TagsPOSTCreate a TagGETList All CampaignsPOSTCreate CampaignGETGet CampaignPATCHUpdate CampaignDELETEDelete CampaignPOSTSend CampaignGETList SubscribersGETGet Tag by ID or Name

Integrations

ClickFunnels IntegrationSystemIO Integration

Features

Affiliate ProgramAccount VerificationLanguageVariablesTag Action LinksSurveysContent Deliverability CheckerSender HealthCampaign Delivery ScoreEmail Engagement ScoreSubscriber EventsRevenue TrackingEmail Sending Queue

Deliverability

How to strengthen DMARCHow to add DMARCHow to fix DKIMHow to verify a sending domainHow to fix MAIL FROMHow to fix BIMIHow to lower bounce rateHow to lower complaint rateHow to fix delivery delaysHow to fix blocklist bouncesHow to fix sending infrastructureHow to fix a dedicated IPHow to fix a failed sendHow to fix a fallback-domain sendHow to fix an invalid email parameterHow to fix sending rate or daily quotaHow to fix a monthly email limitHow to fix a past-due payment pauseHow to fix an admin sending pauseHow to complete additional verificationHow to fix a failed campaignHow to fix a campaign render error

Workflows

WorkflowWorkflow Getting StartedWorkflow TriggersWorkflow Manual EnrollmentWorkflow BranchingWorkflow A/B TestingWorkflow GoalsWorkflow Exit RulesWorkflow Publishing and VersionsWorkflow Test Runs and ResultsWait StepEmail StepAction StepWebhook StepWorkflow Groups

domains

Email DomainsWeb Domains

API Reference

Complete API documentation for Lumail.io integration

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

Machine-readable discovery

  • OpenAPI 3.1 specification - Typed operations, parameters, request bodies, responses, and error schemas for code generators and function calling
  • MCP server manifest - Canonical Streamable HTTP endpoint, OAuth discovery, and MCP documentation
  • MCP server - OAuth-protected tools and readable developer resources
  • llms.txt - Markdown index for agents and retrieval systems
  • Authentication - Organization API token permissions and Bearer usage
  • Webhooks and integrations - ClickFunnels, Systeme.io, and automation setup
  • SDK and CLI - Typed application and terminal access

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
PreviousErrors and RetriesNextAPI Tokens

On This Page

Machine-readable discoveryGetting StartedAvailable EndpointsTransactional EmailsEmail Content FormatsSubscriber ManagementSubscriber TagsEventsTagsAuthenticationRate LimitsTutorialsRelated Documentation
  • Get Subscribers - Retrieve subscriber list
  • Update Subscriber - Update subscriber data
  • Unsubscribe Subscriber - Stop mail without deleting history

    • 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.

    PlanRequests per Minute
    Free100
    Premium700
    Enterprise2,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