Email

Send, track, and manage transactional emails via SMTP.

Requires an SMTP account configured in the dashboard. Supports HTML/text content, attachments (multipart), batch sending with variable substitution, scheduling, and tracking.

Endpoints

Method	Description	Permission
POST	Send an email	email.send
POST	Send email with attachments	email.send
POST	Send emails in batch	email.send
GET	List sent emails	email.history
GET	Get email details	email.history
DELETE	Cancel scheduled email	email.send

Send Email

POST /api/v1/emails/send

Request

Response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "queued",
    "to": "user@example.com",
    "subject": "Welcome!"
  }
}

json

Batch Send

POST /api/v1/emails/batch

Request

Response

{
  "success": true,
  "data": [
    { "id": "uuid-1", "to": "alice@example.com", "status": "queued" },
    { "id": "uuid-2", "to": "bob@example.com", "status": "queued" }
  ],
  "meta": { "total": 2 }
}

json

List & Get Emails

GET /api/v1/emails • GET /api/v1/emails/:id

Request

Response (single email)

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "to": "user@example.com",
    "subject": "Welcome!",
    "status": "sent",
    "created_at": "2026-03-18T10:00:00Z",
    "sent_at": "2026-03-18T10:00:05Z"
  }
}

json