- In the app, go to Settings → API → “Create API key”.
- Copy the key and store securely.
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | yes | Preferred. Bearer <api_key> |
| X-Api-Key | string | no | Alternate header if Bearer isn’t available |
401 { "error": "Invalid API key" }.
Scopes
Optional scopes restrict capabilities (if a key has none, send is allowed for backward compatibility):
| Scope | Required for | Notes |
|---|---|---|
| send_email | POST /api/v1/emails/* | Required for both send and send-global |
| read_sends | GET /api/v1/sends/{id} | Needed when you include a key |
| preferences_read | GET /api/v1/preferences | When using an API key |
| preferences_manage | POST /api/v1/preferences | When using an API key |
- Clients may send
X-Request-Idto correlate logs. - All responses include
X-Request-Id(generated if not provided).
