Documentation Index
Fetch the complete documentation index at: https://docs.fluxomail.com/llms.txt
Use this file to discover all available pages before exploring further.
Step 1 — Get an API key
- In the app, go to Settings → API → “Create API key”.
- Copy the key and keep it server‑side.
Step 2 — Send your first email
Use the v1 send endpoint with an idempotency key.
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 there",
"htmlContent": "<p>Hi there</p>"
}'
Node example
import crypto from 'crypto';
const res = await fetch('https://api.fluxomail.com/api/v1/emails/send', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${process.env.FLUXOMAIL_API_KEY}`,
'Idempotency-Key': `send-${crypto.randomUUID()}`
},
body: JSON.stringify({ to: 'user@example.com', subject: 'Hello', content: 'Hi', htmlContent: '<p>Hi</p>' })
});
const data = await res.json(); // { sendId, status, messageId }
Step 3 — View the delivery timeline
Fetch messages and normalized events for your send.
curl -X GET \
-H "Authorization: Bearer $API_KEY" \
https://api.fluxomail.com/api/v1/sends/$SEND_ID
Step 4 — Events (automatic)
Fluxomail manages provider events. After your first send, delivered/bounced/opened/clicked events appear in the timeline automatically.
Notes
- Use one verified From identity (domain + DKIM) in the dashboard — the API sends with your active identity.
- On 429, back off and retry after
Retry-After. Keep the same Idempotency-Key.
- For scopes and errors, see Authentication and Errors.