Lumail.io
DocsBlogChangelog
⌘K
IntroductionTutorialsAI IntegrationSDKAPI ReferenceIntegrationsFeaturesWorkflows

Tutorials

Create an API TokenSend Transactional Email with SMTPBuild 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 EmailPOSTEmail Verification APIPOSTCreate SubscriberGETGet SubscriberPATCHUpdate SubscriberDELETEDelete SubscriberPOSTAdd Tags to SubscriberDELETERemove Tags from SubscriberPOSTTrack EventGETGet Subscriber EventsGETGet All TagsPOSTCreate a TagGETList All CampaignsPOSTCreate CampaignGETGet CampaignPATCHUpdate CampaignDELETEDelete CampaignPOSTSend CampaignSend Email in HTMLSend Email in MarkdownSend Email in TiptapGETList SubscribersGETGet Tag by ID or Name

Integrations

ClickFunnels IntegrationSystemIO Integration

Features

VariablesTag Action LinksContent Deliverability CheckerEmail Deliverability ScoreEmail Engagement ScoreSubscriber EventsRevenue TrackingEmail Sending Queue

Workflows

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

domains

Email DomainsWeb Domains

Codex (Plugin)

Connect the Codex CLI and Codex app to Lumail over OAuth—no API token in config.toml.

Connect Lumail to Codex and it can read your subscribers, campaigns, workflows and analytics, and draft new ones from the session where you write code. Authentication is a browser sign-in: config.toml holds a URL and nothing else.

Setup: send this to your agent

Paste this into Codex and it does the whole setup for you — configuration, browser login, verification.

Prompt
Read lumail.io/codex/install and set up the Lumail connection for me.

Your agent fetches the machine-readable guide at lumail.io/codex/install, writes the config block, and tells you when to approve the browser prompt.

Administrator access required: you must be an owner or admin of the organization you connect. Losing that role blocks the connection immediately.

Setup: by hand

Add this to ~/.codex/config.toml:

[mcp_servers.lumail]
url = "https://lumail.io/mcp"
oauth_resource = "https://lumail.io/mcp"

Then sign in:

codex mcp login lumail

A Lumail tab opens in your browser. Sign in, pick the organization the agent may reach, and approve the scopes. Verify with:

codex mcp list

lumail should appear at https://lumail.io/mcp, connected. Inside the Codex TUI, /mcp shows the same. Start a new session before your first Lumail prompt so the tool list is picked up.

Migrating from an API token? Delete the bearer_token_env_var line from your [mcp_servers.lumail] block. A stale bearer token shadows the OAuth credential and keeps you on the old endpoint.

If your Codex build supports plugin marketplaces, you can install the packaged plugin instead and skip straight to the login:

codex plugin marketplace add https://github.com/Melvynx/lumail-opensource.git
codex plugin install lumail

Why there is no token

https://lumail.io/mcp is an OAuth 2.1 protected resource with dynamic client registration. Codex registers itself, runs PKCE, and stores the access token in its own credential store — so committing your dotfiles leaks nothing.

Access tokens carry the selected organization as a signed claim, so a session can never reach another organization in your account. Revoke from the connected-apps list in Lumail settings and access stops on the next request.

What the connection can do

ScopeAccess
lumail.readSubscribers, tags, custom fields, campaigns and their analytics, send progress, workflows, org stats, senders, snippets, writing style
lumail.writeAdd subscribers, apply and remove tags in bulk, create and edit campaign drafts, duplicate campaigns, create and configure workflow drafts

Example prompts:

Try it
How did last week's newsletter perform compared to the one before?
Add every trial signup from this CSV and tag them trial-2026.
Draft a re-engagement campaign for subscribers who have not opened in 60 days.
Create a workflow that welcomes new subscribers over five days.

Not available over OAuth

Sending, scheduling, publishing or activating a workflow, unsubscribing, and every delete are not registered on the OAuth endpoint. They are not permission prompts an agent could talk you into — the tools simply do not exist on this connection.

Do that work in the Lumail app, or from your terminal with the CLI, which reaches the full API and signs in with the same browser flow:

npx lumail auth login

Rate limits

PlanRequests/min
Free100
Premium700
Business2,000

Limits are counted per organization.

Troubleshooting

OAuth settings are not discovered: the server URL must be exactly https://lumail.io/mcp, without /api or /sse.

Tools are missing: start a new Codex session. The tool list is read at session start.

"Needs authentication": re-run codex mcp login lumail, and check that no bearer_token_env_var line remains in the block.

No organization is available: ask an owner to promote your membership to owner or admin.

Removal

Delete the [mcp_servers.lumail] block from ~/.codex/config.toml, or revoke the authorization from Lumail settings — revoking there cuts access immediately without touching local config.

Related

  • Claude Code plugin
  • ChatGPT plugin
  • Lumail CLI skill
  • MCP Server reference
Claude Code (Plugin)ChatGPT Plugin

On This Page

Setup: send this to your agentSetup: by handWhy there is no tokenWhat the connection can doNot available over OAuthRate limitsTroubleshootingRemovalRelated

Lumail.io

Email marketing for AI agents. Send newsletters, manage subscribers, and build campaigns with ChatGPT, Claude, Hermes, or OpenClaw.

Plugins

Claude pluginCodex pluginChatGPTCLI + skillsIn-app integration

Product

BlogDocumentationChangelogDashboard

Company

AboutAccount

Legal

TermsPrivacy

8 The Green STE B, Dover Delaware 19901, United States

© 2025 Codelynx, LLC. All rights reserved.

Sign in