Recuperare ed eliminare i lead

Cosa puoi fare

Questi tre endpoint ti permettono di leggere e ripulire le sottomissioni di cattura lead raccolte dai tuoi flipbook:

• Elencare i lead su tutti i tuoi flipbook o su uno specifico, con ricerca, paginazione ed esportazione CSV.
• Eliminare un singolo lead tramite il suo ID.
• Eliminare i lead in blocco tramite filtro (flipbook, email o intervallo di date).

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• L'eliminazione di un singolo lead usa un segmento di percorso {leadId}, e passi anche l'Email del lead e il FlipbookID come parametri di query. L'eliminazione in blocco non ha un parametro nel percorso — filtra tramite parametri di query.
• Questi endpoint non usano un body di richiesta; tutti gli input sono parametri della query string.

Elencare i lead

GET /api/list-leads elenca le sottomissioni di cattura lead raccolte dai tuoi flipbook. Restituisce Items[] più uno schema Columns[] dinamico (per rendere una tabella) e TotalRecordCount. Supporta la paginazione e l'esportazione CSV tramite IsDownload. Passa ItemIDs (ID di flipbook separati da virgola O da barra verticale; vuoto = tutti) per delimitare i risultati. Con IsDownload=false (o vuoto) ottieni il body JSON mostrato sotto; IsDownload=true restituisce invece un'esportazione in file CSV.

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'

Risposta:

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

Eliminare un singolo lead

DELETE /api/delete-lead/{leadId} elimina un singolo lead catturato tramite il suo ID. Il segmento di percorso è il leadId (il LeadID da list-leads); passa anche l'Email del lead e il suo FlipbookID come parametri di query.

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

Risposta:

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

Eliminare i lead in blocco

DELETE /api/delete-leads elimina in blocco i lead tramite filtro. È RICHIESTO ALMENO UNO tra FlipbookID / Email / DateFrom / DateTo — una chiamata senza filtro viene rifiutata (non esiste un percorso "elimina tutto"). L'operazione è sempre delimitata al vendor e restituisce { Result, Deleted (conteggio) }. Ripulisce anche le righe figlie (log delle visualizzazioni / clic sulle CTA / log di esportazione verso il foglio).

• FlipbookID — facoltativo; elimina i lead solo di questo flipbook.
• Email — facoltativo; email in corrispondenza ESATTA.
• DateFrom — facoltativo; elimina i lead catturati in questa data o dopo (corrisponde a Lead.CreatedOn). Qualsiasi data interpretabile, per esempio 2026-01-01 o 2026-01-01T00:00:00Z.
• DateTo — facoltativo; elimina i lead catturati in questa data o prima.

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

Risposta:

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

Errori possibili

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o l'header Authorization: Bearer) sia presente e corretto.

Note

• L'eliminazione in blocco richiede almeno un filtro (FlipbookID, Email, DateFrom o DateTo); una chiamata senza filtro viene rifiutata — non esiste un percorso "elimina tutto".
• L'eliminazione in blocco è sempre delimitata al vendor e rimuove anche le righe figlie correlate (log delle visualizzazioni, clic sulle CTA, log di esportazione verso il foglio).
• Per ottenere l'ID di un lead per l'eliminazione singola, chiama prima GET /api/list-leads.