API Reference
The Mailneo API
54 endpoints across 12 groups. This reference is generated from the API's OpenAPI specification, so it describes exactly what is deployed — not a copy of it that can fall behind.
The Mailneo public REST API. Authenticate with an API key issued from Settings > API keys, presented as X-API-Key or Authorization: Bearer.
Base URL and Version
Base URL
https://api.mailneo.co/api/v2
Every path in this reference is relative to that URL. It is generated from specification 2.0.0, which is the document's own revision — the dated version that governs response shapes is a separate header, covered in the guide.
Authentication
Present your key one of two equivalent ways:
X-API-Key: mk_live_...Authorization: Bearer mk_live_...
Sending two different credentials in one request is refused rather than resolved to one of them. Full authentication guide →
All Endpoints
Grouped as the sidebar groups them. Select an endpoint to jump to its parameters, response schema and example request.
Core
Accounts
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /accounts | accounts:read | List connected sending accounts |
| GET | /accounts/{accountId} | accounts:read | Retrieve a sending account |
Contacts
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /contacts | contacts:read | List contacts |
| POST | /contacts | contacts:write | Create a contact |
| GET | /contacts/{contactId} | contacts:read | Retrieve a contact |
| PATCH | /contacts/{contactId} | contacts:write | Update a contact |
| DELETE | /contacts/{contactId} | contacts:delete | Delete a contact |
| POST | /contacts/bulk | contacts:write | Create or update many contacts |
Lists
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /lists | lists:read | List subscriber lists |
| POST | /lists | lists:write | Create a list |
| GET | /lists/{listId} | lists:read | Retrieve a list |
| PATCH | /lists/{listId} | lists:write | Update a list |
| DELETE | /lists/{listId} | lists:write | Delete a list |
| GET | /lists/{listId}/subscribers | subscribers:read | List the subscribers on a list |
| POST | /lists/{listId}/subscribers | lists:write | Add subscribers to a list |
| DELETE | /lists/{listId}/subscribers/{subscriberId} | lists:write | Unsubscribe a subscriber from a list |
Segments
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /segments | segments:read | List segments |
| POST | /segments | segments:write | Create a segment |
| GET | /segments/{segmentId} | segments:read | Retrieve a segment |
| PATCH | /segments/{segmentId} | segments:write | Update a segment |
| DELETE | /segments/{segmentId} | segments:write | Delete a segment |
| GET | /segments/{segmentId}/count | segments:read | Count the subscribers a segment matches |
Subscribers
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /subscribers | subscribers:read | List newsletter subscribers |
| POST | /subscribers | subscribers:write | Create a subscriber |
| GET | /subscribers/{subscriberId} | subscribers:read | Retrieve a subscriber |
| PATCH | /subscribers/{subscriberId} | subscribers:write | Update a subscriber |
| DELETE | /subscribers/{subscriberId} | subscribers:delete | Delete a subscriber |
Sending
Campaigns
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /campaigns | campaigns:read | List campaigns |
| GET | /campaigns/{campaignId} | campaigns:read | Retrieve a campaign |
Newsletters
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /newsletters | newsletters:read | List newsletters |
| GET | /newsletters/{newsletterId} | newsletters:read | Retrieve a newsletter |
Templates
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /templates | templates:read | List templates |
| POST | /templates | templates:write | Create a template |
| GET | /templates/{templateId} | templates:read | Retrieve a template |
| PATCH | /templates/{templateId} | templates:write | Update a template |
| DELETE | /templates/{templateId} | templates:write | Delete a template |
Suppression
Suppressions
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /suppressions | suppressions:read | List suppressed addresses |
| POST | /suppressions | suppressions:write | Add addresses to the suppression list |
| GET | /suppressions/{email} | suppressions:read | Check whether an address is suppressed |
| GET | /unsubscribes | suppressions:read | List unsubscribe events |
| DELETE | /suppressions/{suppressionId} | suppressions:delete | Remove an address from the suppression list (un-suppress) |
Insights
Analytics
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /analytics/overview | analytics:read | Delivery and engagement totals |
| GET | /analytics/devices | analytics:read | Device, OS and browser breakdown |
| GET | /analytics/geography | analytics:read | Country breakdown |
Platform
Webhooks
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /webhooks | webhooks:read | List webhook endpoints |
| POST | /webhooks | webhooks:write | Register a webhook endpoint |
| GET | /webhooks/events | webhooks:read | List subscribable event types |
| GET | /webhooks/{webhookId} | webhooks:read | Retrieve a webhook endpoint |
| PATCH | /webhooks/{webhookId} | webhooks:write | Update a webhook endpoint |
| DELETE | /webhooks/{webhookId} | webhooks:write | Delete a webhook endpoint |
| GET | /webhooks/{webhookId}/deliveries | webhooks:read | List an endpoint's deliveries |
| POST | /webhooks/{webhookId}/deliveries/{deliveryId}/replay | webhooks:write | Replay a delivery |
Guides
Getting Started
Authenticate with a key, read the response envelope, page with cursors, sync incrementally, handle the error codes, and stay inside the rate limits.
Planned guides
These are placeholders, not summaries. The features do not exist yet, and we would rather leave a marked gap than publish a guide to something you cannot call:
- OAuth for third-party apps — not available yet. API keys are the only credential the API accepts.
Until then, the integrations guide covers what is connectable today.