Email API reference

The Email API sends messages through the same pipeline, limits and credits as the SMTP relay. Your account needs SMTP relay access (see Send email with the SMTP relay) and a verified sending domain.

Authentication

Create an API key in Settings → API keys and send it as a bearer token. Always include Accept: application/json.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Send a message

POST /api/v1/send

{
  "from": "Your Store <orders@yourdomain.com>",
  "to": ["Jane Doe <jane@example.com>"],
  "cc": ["accounts@example.com"],
  "bcc": ["archive@yourdomain.com"],
  "reply_to": "support@yourdomain.com",
  "subject": "Your order #1024",
  "html": "<p>Thanks for your order, Jane!</p>",
  "text": "Thanks for your order, Jane!",
  "tags": ["order-confirmation"],
  "headers": { "X-Order-Id": "1024" },
  "attachments": [
    { "filename": "invoice-1024.pdf", "content": "JVBERi0xLjQK...", "content_type": "application/pdf" }
  ]
}

Each unique recipient (to, cc and bcc) costs 1 credit.

Response 202 Accepted

{
  "id": "01JABCDEF0123456789XYZ0000",
  "status": "queued",
  "message_id": "01JABCDEF0123456789XYZ0000@smtp.inboxroads.com",
  "credits_charged": 3,
  "recipients": [
    { "email": "jane@example.com", "type": "to", "status": "queued", "error": null }
  ]
}

Check status

• GET /api/v1/messages/{id} returns the message and each recipient's status: queued, sent, delivered, bounced, complained, failed or suppressed.
• GET /api/v1/messages?status=failed&per_page=50 lists recent messages.

For real-time updates, use webhooks instead of polling.

Errors