API-Dokumentation für Entwickler

Erste Schritte

Jeder kostenpflichtige Tarif beinhaltet vollen Zugriff auf die REST-API. Erstellen Sie in Ihrem Konto unter Konto → API-Schlüssel einen Schlüssel und senden Sie ihn mit jeder Anfrage mit:

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

Basis-URL: https://mailflow.top/api/index.php · Antworten erfolgen im JSON-Format mit einem status-Feld mit dem Wert success oder error. Im kostenlosen Tarif ist die API nicht verfügbar.

Kernressourcen

Die Plattform ist MailWizz-kompatibel, daher ist die komplette Kern-API – Listen, Abonnenten, Segmente, benutzerdefinierte Felder, Kampagnen, Tracking, Vorlagen, Transaktions-E-Mails, Bounces, Abmeldungen – interaktiv (OpenAPI) dokumentiert unter:

→ Interaktive API-Referenz (OpenAPI)

Bestehende MailWizz-SDKs (z. B. das offizielle PHP SDK) funktionieren sofort – richten Sie sie einfach auf die oben genannte Basis-URL aus.

KI-Endpunkte

Die KI-Funktionen sind vollwertige Bestandteile der API. Derselbe Schlüssel, dieselbe Authentifizierung sowie dieselben Tariflimits und dieselbe Credit-Abrechnung wie in der Web-App.

GET /ai/credits

Ihr KI-Credit-Zähler für den aktuellen Monat. Credits gelten pro Abrechnungsmonat; nicht genutzte Credits werden nicht übertragen.

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

GET /ai/replies

Smart-Replies-Klassifizierungen für Ihre Kampagnen – versorgen Sie Ihr CRM mit Informationen darüber, wer interessiert ist, wer eine Frage gestellt und wer sich beschwert hat. Filter: 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

KI-Engagement-Stufen (vip, engaged, passive, at_risk, dormant) pro Liste – dasselbe Scoring, das Autopilot und Rückgewinnung steuert.

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

POST /ai/subject-lines

Erzeugt Betreffzeilen in jeder Sprache. Body: topic (erforderlich), count (1–5, Standard 3), language (optional). Verbraucht KI-Credits wie der 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}}

GET /ai/flows · POST /ai/flows/author · POST /ai/flows/<uid>/enroll · POST /ai/flows/<uid>/status

KI-Flow-Builder über die API: Listen Sie Ihre Workflows mit Live-Zählern auf; lassen Sie die KI aus einem in Alltagssprache formulierten Ziel einen kompletten Workflow erstellen ({"goal":"...","list_uid":"..."} – liefert einen Entwurf, den Sie mit {"status":"active"} aktivieren); fügen Sie einen Abonnenten in einen Workflow ein ({"email":"..."}).

curl -X POST -H "X-Api-Key: YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"goal":"When someone replies interested, notify me, wait 2 days, then send a case study"}' \
  https://mailflow.top/api/index.php/ai/flows/author

Fehler & Limits

401 – X-Api-Key fehlt oder ist ungültig
403 – die Funktion ist in Ihrem Tarif nicht enthalten
422 – fehlende/ungültige Parameter
429 – KI-Credit-Limit oder monatliches KI-Kontingent erreicht; wird zu Ihrem nächsten Abrechnungsdatum zurückgesetzt

Lastspitzen werden pro Schlüssel gedrosselt – implementieren Sie bei 429 ein exponentielles Backoff. Fragen? Kontaktieren Sie uns oder eröffnen Sie ein Support-Ticket.

Entwickler-API