API Endpoints

The Mailiam API provides RESTful endpoints for managing forms, sending emails, and processing submissions.

Base URL

https://api.mailiam.io

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.mailiam.io/api/forms

Form Submission

POST /submit/{formId}

Submit data to a form endpoint.

curl -X POST https://api.mailiam.io/submit/contact \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "john@example.com",
    "message": "Hello world"
  }'

Response:

{
  "success": true,
  "message": "Form submitted successfully"
}

Form Management

GET /api/forms

List all forms for your account.

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.mailiam.io/api/forms

Response:

{
  "forms": [
    {
      "id": "contact",
      "name": "Contact Form",
      "submissions": 42,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}

POST /api/forms

Create a new form.

curl -X POST https://api.mailiam.io/api/forms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Newsletter Signup",
    "to": "admin@example.com",
    "subject": "New Newsletter Subscription"
  }'

Email Sending

POST /api/email/send

Send a transactional email.

curl -X POST https://api.mailiam.io/api/email/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "subject": "Welcome!",
    "template": "welcome",
    "data": {
      "name": "John Doe"
    }
  }'

Error Responses

All endpoints return consistent error responses:

{
  "error": true,
  "message": "Invalid API key",
  "code": 401
}

Rate Limits

• Free Plan: 100 requests/hour
• Pro Plan: 1,000 requests/hour
• Enterprise: Custom limits

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200