Skip to main content
Fluxomail provides a simple HTTP+JSON API to send emails, manage preferences, and inspect delivery timelines. Base URL
  • Production: https://api.fluxomail.com/api/v1
Base URLs
  • Public API: https://api.fluxomail.com/api/v1
  • App (admin routes, webhooks, tracking): https://app.fluxomail.com
OpenAPI & SDKs
  • Download the OpenAPI spec: /api-reference/openapi.fluxomail.json
  • See SDKs & Clients for minimal clients and usage
Authentication
  • Create an API key in the app: Settings → API → Create
  • Send it as Authorization: Bearer <api_key> (or x-api-key)
  • Optional scopes limit access: send_email, read_sends, preferences_read, preferences_manage
First request
BASE=https://api.fluxomail.com
curl -X POST "$BASE/api/v1/emails/send" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: send-$(uuidgen)" \
  -d '{
    "to": "user@example.com",
    "subject": "Hello",
    "content": "Hi",
    "htmlContent": "<p>Hi</p>"
  }'
Idempotency
  • Provide Idempotency-Key to safely retry POSTs; duplicates return the original result (reused: true).
Rate limits
  • Per‑key per‑minute. On 429, backoff and retry after Retry-After seconds.
Errors
  • JSON body: { "error": string }
  • Statuses: 400 invalid, 401 invalid key, 403 missing scope or policy restriction, 404 not found, 429 rate limited, 500 internal
CORS
  • Public endpoints support CORS (GET/POST/OPTIONS); prefer server‑side calls when using API keys.
Quick links
  • Send an email → /api-reference/fluxomail/send-email
  • Send (global) → /api-reference/fluxomail/send-global
  • Preferences → /api-reference/fluxomail/preferences
  • Get timeline → /api-reference/fluxomail/get-send
  • Provider events → /api-reference/fluxomail/webhooks
  • Roadmap → /api-reference/roadmap
  • Versioning → /api-reference/versioning