Self-hosted email service APIs allow you to send transactional emails, manage domains, and handle audience and contacts programmatically.

​
Getting Started

To start using the self-hosted email service APIs:

  1. Login to your self-hosted email service account at your domain. For example, if your domain is example.com, you can login at auth.example.com.
  2. Create an API key from the dashboard
  3. Use your API key in the Authorization header for all requests: 
    Authorization: Bearer <your-api-key>

​
Base URL

All API endpoints are prefixed with api. subdomain:

https://api.<your-domain>

​
API Versioning

The current version of the API is v1. All endpoints are prefixed with /v1/:

https://api.example.com/v1/emails

​
Error Handling

The API uses standard HTTP status codes and returns error messages in a consistent format:

{
  "message": "Error description",
  "code": "error_code" // Only included for authentication errors
}

Common status codes:

  • 200: Success
  • 201: Created
  • 204: No Content
  • 400: Bad Request
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests

​
Support

Need help? We’re here for you: