API Documentation

Integrate with the BYOMailer API to manage contacts, tags, and mailing lists programmatically.

Getting Started

Follow these steps to start using the API.

If you don't have an account yet, sign up or log in to get started.

Navigate to Settings → API Tokens in your dashboard to create a new API token.

Your token will only be shown once. Make sure to copy and store it securely.

Include your API token in the Authorization header of all requests. See the Authentication section below for details.

All API requests require authentication using a Bearer token. You can create API tokens from your account settings.

Include this header in all API requests

Authorization: Bearer your-api-token-here

/api