API Reference

Complete REST API documentation for developers.

REST API v1JSONRate Limited
Base URL:
https://www.mailaura.io/api/v1

Interactive API Documentation

Test all endpoints directly in your browser with Swagger UI

Authentication

All API requests require an API key. You can create API keys in the dashboard under Settings → API Keys.

curl -X GET "https://www.mailaura.io/api/v1/campaigns" \
  -H "X-API-Key: ml_live_abc123xyz789"

API Key Permissions

  • readRead-only access to resources
  • writeCreate, update, and delete resources
  • sendSend campaigns

Examples

Add Subscriber
Add a new subscriber with tags and custom fields.
curl -X POST "https://www.mailaura.io/api/v1/subscribers" \
  -H "X-API-Key: ml_live_abc123xyz789" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "listId": "clx456def",
    "firstName": "Jane",
    "lastName": "Smith",
    "tags": ["vip", "newsletter"]
  }'
Send Transactional Email
Send an email via the Transactional API (password reset, order confirmation, etc.)
curl -X POST "https://www.mailaura.io/api/v1/send" \
  -H "X-Mailaura-Key: ml_trans_live_abc123xyz789" \
  -H "X-Mailaura-Secret: your-secret-here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "from": "noreply@yourapp.com",
    "subject": "Your Order Confirmation",
    "html": "<h1>Thank you!</h1><p>Order confirmed.</p>",
    "priority": "high"
  }'

Note: Transactional API keys use the prefix ml_trans_live_ or ml_trans_test_ (Sandbox). Create them in Dashboard → Settings → Transactional Emails.

Rate Limiting

API requests are rate-limited based on your plan. Rate limit headers are included in all responses.

Free

100 / h

Starter

500 / h

Pro

2,000 / h

Business

10,000 / h

X-RateLimit-Limit: 1000

X-RateLimit-Remaining: 999

X-RateLimit-Reset: 1699999999

Endpoints

The full endpoint documentation with parameters, request/response examples, and try-it-out is available in the interactive Swagger UI.

Campaigns

GET, POST, PUT, DELETE

REST

Lists

GET, POST, PUT, DELETE

REST

Subscribers

GET, POST, PUT, DELETE

REST

Templates

GET, POST, PUT, DELETE

REST

Webhooks

GET, POST

REST

Transactional Emails

POST

REST

Further Reading