Leads ophalen en verwijderen

Wat je kunt doen

Met deze drie endpoints lees en ruim je de lead-capture-inzendingen op die je flipbooks verzamelen:

• Bekijk de leads over al je flipbooks of één specifieke, met zoeken, paginering en CSV-export.
• Verwijder één lead via zijn ID.
• Verwijder leads in bulk per filter (flipbook, e-mail of datumbereik).

Voordat je begint

• Een API-sleutel — meegestuurd als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• Het verwijderen van één lead gebruikt een {leadId}-padsegment, en je geeft ook de Email en FlipbookID van de lead mee als queryparameters. Bulkverwijderen heeft geen padparameter — het filtert via queryparameters.
• Deze endpoints gebruiken geen request-body; alle invoer bestaat uit query-stringparameters.

Leads opsommen

GET /api/list-leads somt de lead-capture-inzendingen op die je flipbooks hebben verzameld. Het geeft Items[] terug plus een dynamisch Columns[]-schema (om een tabel te renderen) en TotalRecordCount. Het ondersteunt paginering en CSV-export via IsDownload. Geef ItemIDs mee (flipbook-ID's gescheiden door komma OF pipe; leeg = alle) om de resultaten af te bakenen. Met IsDownload=false (of leeg) krijg je de JSON-body die hieronder wordt getoond; IsDownload=true geeft in plaats daarvan een CSV-bestandsexport terug.

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'

Response:

{
  "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
}

Eén lead verwijderen

DELETE /api/delete-lead/{leadId} verwijdert één vastgelegde lead via zijn ID. Het padsegment is de leadId (de LeadID uit list-leads); geef ook de Email en de FlipbookID van de lead mee als queryparameters.

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

Response:

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

Leads in bulk verwijderen

DELETE /api/delete-leads verwijdert leads in bulk per filter. Ten minste ÉÉN van FlipbookID / Email / DateFrom / DateTo is VERPLICHT — een aanroep zonder filter wordt geweigerd (er is geen "alles verwijderen"-pad). De bewerking is altijd vendor-gebonden en geeft { Result, Deleted (aantal) } terug. Het ruimt ook onderliggende rijen op (weergavelogboek / CTA-kliks / sheet-exportlogboek).

• FlipbookID — optioneel; verwijder alleen leads op deze flipbook.
• Email — optioneel; EXACT overeenkomend e-mailadres.
• DateFrom — optioneel; verwijder leads die op/na deze datum zijn vastgelegd (komt overeen met Lead.CreatedOn). Elke parseerbare datum, bijv. 2026-01-01 of 2026-01-01T00:00:00Z.
• DateTo — optioneel; verwijder leads die op/voor deze datum zijn vastgelegd.

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

Response:

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

Mogelijke fouten

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header (of Authorization: Bearer-header) aanwezig en correct is.

Opmerkingen

• Bulkverwijderen vereist ten minste één filter (FlipbookID, Email, DateFrom of DateTo); een aanroep zonder filter wordt geweigerd — er is geen "alles verwijderen"-pad.
• Bulkverwijderen is altijd vendor-gebonden en verwijdert ook gerelateerde onderliggende rijen (weergavelogboek, CTA-kliks, sheet-exportlogboek).
• Om de ID van een lead te krijgen voor het verwijderen van één lead, roep je eerst GET /api/list-leads aan.