Developer API Documentation

Getting started

Every paid plan includes full REST API access. Generate a key in your account under Account → API keys, then send it with every request:

curl -H "X-Api-Key: YOUR_KEY" https://mailflow.top/api/index.php/lists

Base URL: https://mailflow.top/api/index.php · Responses are JSON with a status field of success or error. The API is not available on the Free plan.

Core resources

The platform is MailWizz-compatible, so the complete core API — lists, subscribers, segments, custom fields, campaigns, tracking, templates, transactional email, bounces, unsubscribes — is documented interactively (OpenAPI) at:

→ Interactive API reference (OpenAPI)

Existing MailWizz SDKs (e.g. the official PHP SDK) work out of the box — point them at the base URL above.

AI endpoints

The AI features are first-class API citizens. Same key, same auth, and the same plan limits and credit metering as the web app.

GET /ai/credits

Your AI credit meter for the current month. Credits are per billing month and unused credits do not carry over.

{"status":"success","data":{"unlimited":false,"limit":750,"used":112,"remaining":638}}

GET /ai/replies

Smart Replies classifications for your campaigns — feed your CRM with who is interested, who asked a question, who complained. Filters: category (interested, question, complaint, unsubscribe_request, auto_reply, out_of_office, bounce, other), campaign_uid, since (YYYY-MM-DD), page, per_page (max 50).

curl -H "X-Api-Key: YOUR_KEY" \
  "https://mailflow.top/api/index.php/ai/replies?category=interested&since=2026-08-01"

{"status":"success","data":{"count":42,"current_page":1,"per_page":20,"total_pages":3,
  "records":[{"from_email":"[email protected]","subject":"RE: your offer",
    "category":"interested","confidence":98,"engine":"embeddings",
    "summary":"...","suggested_reply":"...","date_added":"2026-08-24 18:21:19",
    "campaign_uid":"py794hjqk8a8d"}]}}

GET /ai/tiers

AI engagement tiers (vip, engaged, passive, at_risk, dormant) per list — the same scoring that drives autopilot and win-back.

{"status":"success","data":{"records":[
  {"list_uid":"qk661oq7nl8c1","name":"Main list","tiers":{"engaged":1200,"passive":3400,"dormant":900}}]}}

POST /ai/subject-lines

Generate subject lines in any language. Body: topic (required), count (1–5, default 3), language (optional). Spends AI credits like the web editor.

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"topic":"Summer sale for B2B customers","count":3,"language":"Greek"}' \
  https://mailflow.top/api/index.php/ai/subject-lines

{"status":"success","data":{"subjects":["...","...","..."],"credits_remaining":636}}

Errors & limits

401 — missing or invalid X-Api-Key
403 — the feature is not included in your plan
422 — missing/invalid parameters
429 — AI credit limit or monthly AI allowance reached; resets on your next billing date

Bursts are throttled per key — implement exponential backoff on 429. Questions? Contact us or open a support ticket.

Developer API