Beta Feature1 min read

API Keys

Create `eg_...` sending keys in the dashboard portal (not via Swagger).

Module:dashboard/api-keys/introduction

Generate a sending key in the portal#

Programmatic send (OTP, transactional, bulk, campaigns) uses an API key (eg_...), not a dashboard login token.

Sign in at the Mail Champ dashboard
Open API keys
Create a key and copy it immediately (shown once)
Store it on your server (environment variable). Never put it in the browser, localStorage, or a public repo.

Then call send endpoints with:

Do not use a dashboard JWT/access token for sending.

Interactive API docs: use Explore API in the app (from PUBLIC_API_URL / NEXT_PUBLIC_API_URL) or open {API}/docs.

The plaintext key is shown only once at create or rotate time.
Rotate issues a new secret for the same key id; the old secret stops working immediately.
In production, keep AUTH_REQUIRED=true / API_KEY_REQUIRED=true so sending is never anonymous.
Revoke unused keys from the same API keys page.

Tracking (Open + Click)

Suppressions