TopMail API Documentation
Build powerful email workflows with the TopMail REST API. Send transactional emails, manage contacts and lists, track campaign performance, and automate your email infrastructure.
For Coding Agents
Give your AI coding assistant full API context for autonomous development.
Quickstart
Send your first email in 5 minutes with a step-by-step guide.
Authentication
Learn about API keys, rate limits, and the permissions model.
Sandbox Mode
Test your integration safely without sending real emails.
SDKs
Official client libraries for Node.js, Python, and more.
API Reference
All endpoints use the base URL https://api.topmail.so/api/v1 and require authentication via API key.
ContactsCreate, read, update, and delete contacts.
Lists & SegmentsManage static and dynamic lists, add/remove members.
SegmentsCreate dynamic segments and estimate audience sizes.
TagsTag contacts and manage tag assignments.
CampaignsRetrieve campaign details and performance stats.
AutomationsControl automation workflows and trigger flows.
TemplatesList and retrieve email templates.
EmailSend transactional emails and check delivery status.
DomainsAdd and verify custom sending domains via API.
SuppressionsManage suppressed email addresses.
WebhooksReceive real-time notifications for email events.
TrackingTrack product views and user activity.
ConversionsReport conversion events for attribution.