Mail API reference

The Mail API lets your own code read, search, send and reply to mail, and lets an admin manage the mailboxes on a domain. It is a plain JSON API over HTTPS — no SDK is required, and anything that can make an HTTP request can use it.

Base URL and authentication

• Base URL — https://nevtanemailapi.nevtan.com:5008/api/v1
• Authentication — an API key on every request, as Authorization: Bearer nvt_live_… or X-API-Key: nvt_live_…
• Request bodies — JSON, with Content-Type: application/json
• Responses — JSON. Field names use lower case with underscores, and timestamps are ISO 8601.

Your first request

Start with /me. It confirms the key works and tells you which account and role it carries:

curl https://nevtanemailapi.nevtan.com:5008/api/v1/me \
  -H "Authorization: Bearer nvt_live_xxxxxxxx…"

{
  "id": 1042,
  "email": "priya@yourcompany.com",
  "name": "Priya Singh",
  "role": "admin"
}

The role field tells you whether the key may use the admin-only endpoints below.

Endpoints

Every path below is relative to the base URL.

Sending a message takes a single address or a list, whichever suits your code:

curl -X POST https://nevtanemailapi.nevtan.com:5008/api/v1/emails/send \
  -H "Authorization: Bearer nvt_live_xxxxxxxx…" \
  -H "Content-Type: application/json" \
  -d '{
        "to": ["customer@example.com"],
        "subject": "Your order has shipped",
        "body": "<p>It is on its way.</p>",
        "is_html": true
      }'

The email object

Returned by the message endpoints, and delivered by the email.received and email.sent webhooks:

The mailbox object

Returned by the mailbox endpoints, and delivered by the mailbox.created webhook:

Limits

Errors

An error returns the matching HTTP status and a JSON body with a single error field describing what went wrong:

{ "error": "Not found" }