API Reference

The Nevarmail API provides a unified REST interface for managing email delivery across multiple providers. All endpoints are served over HTTPS and return JSON responses.

Base URL

https://api.nevarmail.com

For local development:

http://localhost:3400

Authentication

All API requests require authentication via an API key passed in the Authorization header:

Authorization: Bearer nvm_your_api_key_here

API keys are scoped to specific permissions. See the full API reference for details on available scopes and authentication flows.

Resources

• Email -- Send transactional and templated emails
• Scheduling -- Schedule emails for future delivery
• Templates -- Manage email templates with variable substitution
• Providers -- Configure and monitor email service providers
• Senders -- Manage verified sender identities
• Analytics -- Track email delivery, opens, clicks, and bounces
• Inbound Routing -- Configure rules for processing inbound emails
• System -- Health checks and system information

Rate Limiting

API requests are rate-limited per API key. Rate limit headers are included in every response:

• X-RateLimit-Limit -- Maximum requests allowed in the window
• X-RateLimit-Remaining -- Requests remaining in the current window
• X-RateLimit-Reset -- Unix timestamp when the window resets

When rate-limited, the API returns HTTP 429 with a Retry-After header.

Error Handling

All errors return a consistent JSON structure:

{
  "error": "Human-readable error message",
  "code": "MACHINE_READABLE_CODE"
}

Common error codes: