Leads abrufen und löschen

Was du tun kannst

Mit diesen drei Endpunkten liest und bereinigst du die Lead-Einsendungen, die deine Flipbooks sammeln:

• Auflisten der Leads über alle deine Flipbooks oder ein bestimmtes, mit Suche, Paging und CSV-Export.
• Einen einzelnen Lead löschen über seine ID.
• Leads gebündelt löschen nach Filter (Flipbook, E-Mail oder Datumsbereich).

Bevor du loslegst

• Einen API-Schlüssel – wird entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Das Löschen eines einzelnen Leads verwendet ein {leadId}-Pfadsegment, und du übergibst außerdem die Email des Leads und die FlipbookID als Query-Parameter. Das gebündelte Löschen hat keinen Pfadparameter – es filtert über Query-Parameter.
• Diese Endpunkte verwenden keinen Request-Body; alle Eingaben sind Query-String-Parameter.

Leads auflisten

GET /api/list-leads listet die Lead-Einsendungen auf, die deine Flipbooks gesammelt haben. Es gibt Items[] plus ein dynamisches Columns[]-Schema (um eine Tabelle darzustellen) und TotalRecordCount zurück. Es unterstützt Paging und CSV-Export über IsDownload. Übergib ItemIDs (Flipbook-IDs, durch Komma ODER Pipe getrennt; leer = alle), um die Ergebnisse einzugrenzen. Mit IsDownload=false (oder leer) bekommst du den unten gezeigten JSON-Body; IsDownload=true gibt stattdessen einen CSV-Datei-Export zurück.

curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=&SearchText=&PageNo=1&Offset=0&IsDownload=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Items": [],
  "Columns": [
    {
      "ID": 1,
      "data": "ID",
      "title": "ID",
      "type": "numeric",
      "hidden": true,
      "readOnly": true,
      "defaultValue": "",
      "source": "",
      "width": 0,
      "backgroundColor": "",
      "align": "left"
    }
  ],
  "TotalRecordCount": 0
}

Einen einzelnen Lead löschen

DELETE /api/delete-lead/{leadId} löscht einen einzelnen erfassten Lead über seine ID. Das Pfadsegment ist die leadId (die LeadID aus list-leads); übergib außerdem die Email des Leads und seine FlipbookID als Query-Parameter.

curl -X DELETE 'https://go.fliplink.me/api/delete-lead/0?Email=foo@example.com&FlipbookID={{flipbookId}}' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Message": "Deleted successfully"
}

Leads gebündelt löschen

DELETE /api/delete-leads löscht Leads gebündelt nach Filter. Mindestens EINES von FlipbookID / Email / DateFrom / DateTo ist ERFORDERLICH – ein Aufruf ohne Filter wird abgelehnt (es gibt keinen „alle löschen“-Weg). Die Operation ist immer vendor-gescoped und gibt { Result, Deleted (Anzahl) } zurück. Sie räumt außerdem untergeordnete Zeilen auf (View-Log / CTA-Klicks / Sheet-Export-Log).

• FlipbookID – optional; lösche nur Leads dieses Flipbooks.
• Email – optional; EXAKTE E-Mail-Übereinstimmung.
• DateFrom – optional; lösche Leads, die an/nach diesem Datum erfasst wurden (passt zu Lead.CreatedOn). Jedes parsebare Datum, z. B. 2026-01-01 oder 2026-01-01T00:00:00Z.
• DateTo – optional; lösche Leads, die an/vor diesem Datum erfasst wurden.

curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID={{flipbookId}}&Email=&DateFrom=&DateTo=' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder der Authorization: Bearer-Header) vorhanden und korrekt ist.

Hinweise

• Das gebündelte Löschen erfordert mindestens einen Filter (FlipbookID, Email, DateFrom oder DateTo); ein Aufruf ohne Filter wird abgelehnt – es gibt keinen „alle löschen“-Weg.
• Das gebündelte Löschen ist immer vendor-gescoped und entfernt außerdem zugehörige untergeordnete Zeilen (View-Log, CTA-Klicks, Sheet-Export-Log).
• Um die ID eines Leads für das Einzel-Löschen zu erhalten, rufe zuerst GET /api/list-leads auf.