Mimeo documentation
Mimeo is email automation you own. One install, one customer — yours. These docs cover both halves of how you run it: the web UI you click through, and the API your coding agent talks to.
New here? Start with Getting started. It walks from first login to a test email landing in your inbox.
Browse the docs
- Usage Working in the app: people, CSV import, authoring emails, and connecting a sending provider.
- API The HTTP interface your agent and your app use: events, people, flows, emails, sequences, broadcasts and the definitions repo.
- MCP server A native tool surface for coding agents, running on your instance. Add it to Claude Code with one command.
- CLI Your whole operation as files in a git repo you own — pull, edit, push through a diff and a rehearsal.
How Mimeo is put together
Your instance owns the data and the logic — people, custom fields, tags, events, money history, emails, templates, tracking, and the send log all live in your own database. A pluggable sending provider handles delivery to the inbox. You connect one (today that's Bento) and Mimeo hands it the finished message.
Everything that enters Mimeo from outside — a signup, a purchase, a renewal, an opt-in — arrives as an event. That one endpoint upserts the person, records first-touch attribution, appends to their timeline, and writes the money tables. If you learn one thing about the API, learn the event contract.
What's here today
Mimeo is shipping in stages, and these docs only describe what actually exists. Right now that's: people management and GDPR tooling, CSV import, custom fields and tags, the email library and editor with templates and previews, open and click tracking, the event API, and the subscription-management API — plus the whole automation engine: sequences, flows with dry runs and versions, the scheduled queue, guards, send windows, and the flow API.
And the daily-driver console: segments with watchdogs, broadcasts, reporting across emails, sequences, flows and broadcasts, the dashboard, and keyboard-first navigation.
The agent surface is here too: the CLI and a definitions repo for anything you want reviewed as a diff, the MCP server for questions and one-off changes, and the reference section — the flow schema, the event contract, the repo layout and how to write your own sending adapter — written so an agent can operate an instance from the docs alone.