Récupérer et supprimer des prospects

Ce que tu peux faire

Ces trois endpoints te permettent de lire et de nettoyer les soumissions de capture de prospects que tes flipbooks collectent :

• Lister les prospects de tous tes flipbooks ou d'un flipbook précis, avec recherche, pagination et export CSV.
• Supprimer un seul prospect par son ID.
• Supprimer des prospects en masse par filtre (flipbook, e-mail ou plage de dates).

Avant de commencer

• Une clé d'API — envoyée soit dans l'en-tête X-Api-Key, soit sous la forme Authorization: Bearer YOUR_API_KEY.
• Toutes les requêtes vont vers l'URL de base https://go.fliplink.me.
• La suppression d'un seul prospect utilise un segment de chemin {leadId}, et tu passes aussi l'Email et le FlipbookID du prospect en paramètres de requête. La suppression en masse n'a pas de paramètre de chemin — elle filtre via des paramètres de requête.
• Ces endpoints n'utilisent pas de corps de requête ; toutes les entrées sont des paramètres de chaîne de requête.

Lister les prospects

GET /api/list-leads liste les soumissions de capture de prospects collectées par tes flipbooks. Il renvoie Items[] plus un schéma dynamique Columns[] (pour afficher un tableau) et TotalRecordCount. Il prend en charge la pagination et l'export CSV via IsDownload. Passe ItemIDs (IDs de flipbook séparés par des virgules OU des barres verticales ; vide = tous) pour restreindre les résultats. Avec IsDownload=false (ou vide) tu obtiens le corps JSON montré ci-dessous ; IsDownload=true renvoie un export de fichier CSV à la place.

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'

Réponse :

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

Supprimer un seul prospect

DELETE /api/delete-lead/{leadId} supprime un seul prospect capturé par son ID. Le segment de chemin est le leadId (le LeadID de list-leads) ; passe aussi l'Email du prospect et son FlipbookID en paramètres de requête.

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

Réponse :

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

Supprimer des prospects en masse

DELETE /api/delete-leads supprime des prospects en masse par filtre. Au moins UN de FlipbookID / Email / DateFrom / DateTo est REQUIS — un appel sans filtre est rejeté (il n'y a pas de chemin « tout supprimer »). L'opération est toujours limitée au vendeur et renvoie { Result, Deleted (count) }. Elle nettoie aussi les lignes enfants (journal des vues / clics CTA / journal d'export vers la feuille).

• FlipbookID — facultatif ; supprime les prospects de ce flipbook uniquement.
• Email — facultatif ; e-mail en correspondance EXACTE.
• DateFrom — facultatif ; supprime les prospects capturés à partir de cette date (correspond à Lead.CreatedOn). Toute date analysable, par exemple 2026-01-01 ou 2026-01-01T00:00:00Z.
• DateTo — facultatif ; supprime les prospects capturés jusqu'à cette date incluse.

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

Réponse :

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

Erreurs possibles

• Clé d'API manquante ou invalide → HTTP 401. Cela renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key (ou l'en-tête Authorization: Bearer) est présent et correct.

Remarques

• La suppression en masse exige au moins un filtre (FlipbookID, Email, DateFrom ou DateTo) ; un appel sans filtre est rejeté — il n'y a pas de chemin « tout supprimer ».
• La suppression en masse est toujours limitée au vendeur et retire aussi les lignes enfants liées (journal des vues, clics CTA, journal d'export vers la feuille).
• Pour obtenir l'ID d'un prospect en vue d'une suppression unique, appelle d'abord GET /api/list-leads.