API Reference
Manage campaigns, lists, contacts, servers and more over a consistent JSON REST API. Every request is authenticated with a Bearer token.
Authentication
Send your API token as a Bearer token on every request. Tokens are created per customer under your account’s API settings.
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
curl https://getmailpurse.com/api/v1/lists \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Base URL: https://getmailpurse.com/api · OpenAPI spec
Guides
Errors and status codes
Code Meaning 200 Success 401 Missing or invalid API token 403 Authenticated, but the account lacks the required permission 404 Resource not found (or not owned by the token’s…
Getting started with the API
The MailPurse REST API exposes your account’s lists, contacts, campaigns, servers and billing over JSON over HTTPS. All endpoints are prefixed with /api.
Authentication
Every API request is authenticated with a personal Bearer token (Laravel Sanctum).
Pagination and rate limits
List endpoints return paginated results. Use the page query parameter and inspect the response meta: { "data": [ … ], "meta": { "current_page": 1, "last_page": 4, "per_page": 15,…
Endpoints · 83
Email Lists
Contacts
Campaigns
/v1/campaigns
POST
/v1/campaigns
DELETE
/v1/campaigns/{campaign}
GET
/v1/campaigns/{campaign}
PUT
/v1/campaigns/{campaign}
POST
/v1/campaigns/{campaign}/pause
GET
/v1/campaigns/{campaign}/recipients
POST
/v1/campaigns/{campaign}/rerun
POST
/v1/campaigns/{campaign}/resume
POST
/v1/campaigns/{campaign}/start
GET
/v1/campaigns/{campaign}/stats
Automations
/v1/auto-responders
POST
/v1/auto-responders
DELETE
/v1/auto-responders/{autoResponder}
GET
/v1/auto-responders/{autoResponder}
PUT
/v1/auto-responders/{autoResponder}
POST
/v1/auto-responders/{autoResponder}/pause
GET
/v1/auto-responders/{autoResponder}/recipients
POST
/v1/auto-responders/{autoResponder}/rerun
POST
/v1/auto-responders/{autoResponder}/resume
POST
/v1/auto-responders/{autoResponder}/start
GET
/v1/auto-responders/{autoResponder}/stats
Transactional Emails
/v1/transactional-emails
POST
/v1/transactional-emails
DELETE
/v1/transactional-emails/{transactionalEmail}
GET
/v1/transactional-emails/{transactionalEmail}
PUT
/v1/transactional-emails/{transactionalEmail}
POST
/v1/transactional-emails/send
POST
/v1/transactional-emails/send-bulk
POST
/v1/transactional-emails/send-raw
Delivery Servers
/v1/delivery-servers
POST
/v1/delivery-servers
DELETE
/v1/delivery-servers/{deliveryServer}
GET
/v1/delivery-servers/{deliveryServer}
PUT
/v1/delivery-servers/{deliveryServer}
POST
/v1/delivery-servers/{deliveryServer}/resend-verification
POST
/v1/delivery-servers/{deliveryServer}/test-email
POST
/v1/delivery-servers/{deliveryServer}/verify