REST API and MCP
Connect an application or assistant to ApresMail
Use the 111 actions below to work with newsletters, subscribers and campaigns. Call the REST API from your application, or connect an assistant to the MCP server. Both use your account permissions and sending limits.
REST APIJSON in and out
http://localhost:3000/api/v1MCP serverStreamable HTTP
http://localhost:3000/mcp- 1
Create an API key
On the API keys page. Choose what your assistant may do and when its key expires. Sending and subscriber access are separate permissions. Keys are shown once.
- 2
Make a request
Every request sends the key as a bearer token. This one lists your newsletters with their settings.
Terminal curl http://localhost:3000/api/v1/newsletters \ -H "Authorization: Bearer $APRESMAIL_API_KEY" - 3
Or connect an AI assistant
One command for Claude Code. Codex and Cursor take a few lines, and ChatGPT, Claude and Grok Bot connect with your sign-in, on the MCP page.
Terminal claude mcp add --transport http --scope user apresmail http://localhost:3000/mcp \ --header "Authorization: Bearer $APRESMAIL_API_KEY"
What you can do
Campaigns25Drafts, test emails, scheduling, sending, sending in steps and reports.Overview1Subscribers, email results and sends per hour, as on the dashboard's first page.Newsletters7Sender, postal address, welcome and confirmation emails, list cleanup, archive and theme.SMS6Contacts19Newsletter-specific compatibility actions. On v2, a contact ID is a NewsletterSubscription ID; add is organizational by default; explicit subscribe:true records owner authorization for unrestricted subscriptions without recipient confirmation. Imports do not imply consent, no welcome/sequence mail starts, and delete removes only that subscription.Subscribers9Canonical v2 profiles and newsletter-specific subscriptions, groups and consent events. Writes are scoped and idempotent; no action grants consent.Recipients2Deprecated v1 account-wide consent reads. V2 accounts use Subscribers actions and receive conflict for these legacy tools.Segments6Saved conditions that pick some of a newsletter's contacts by engagement, signup date, source or address, to send campaigns to them only.Sequences11Groups8On v2 every group belongs to one newsletter: list/create require newsletterId, and membership uses an existing Subscriber in that newsletter. Membership never grants consent. V1 account-wide groups remain available during maintenance.Signup forms6Domains4Own sending domains with their DNS records, and the shared address.Images2Pictures for campaign content, on ApresMail's CDN, kept in the account's library to use again.API keys5Keys for the REST API and MCP.
For agents reading this
- /llms.txt lists these pages and every endpoint.
- /llms-full.txt is the whole reference in Markdown.
- /api/v1/openapi.json is the API as OpenAPI 3.1, made from the same schemas as the MCP tools.