Consultar y eliminar leads

Qué puedes hacer

Estos tres endpoints te permiten leer y depurar los envíos de captura de leads que recogen tus flipbooks:

• Listar los leads de todos tus flipbooks o de uno concreto, con búsqueda, paginación y exportación a CSV.
• Eliminar un solo lead por su ID.
• Eliminar leads en bloque por filtro (flipbook, correo o rango de fechas).

Antes de empezar

• Una clave de API — se envía en el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY.
• Todas las solicitudes van a la URL base https://go.fliplink.me.
• Para eliminar un solo lead se usa un segmento de ruta {leadId}, y además pasas el Email y el FlipbookID del lead como parámetros de consulta. La eliminación en bloque no tiene parámetro de ruta: filtra mediante parámetros de consulta.
• Estos endpoints no usan cuerpo de solicitud; todas las entradas son parámetros de la cadena de consulta.

Listar leads

GET /api/list-leads lista los envíos de captura de leads recogidos por tus flipbooks. Devuelve Items[] más un esquema dinámico Columns[] (para renderizar una tabla) y TotalRecordCount. Admite paginación y exportación a CSV mediante IsDownload. Pasa ItemIDs (IDs de flipbook separados por coma O por barra vertical; vacío = todos) para acotar los resultados. Con IsDownload=false (o vacío) obtienes el cuerpo JSON que se muestra abajo; IsDownload=true devuelve en su lugar una exportación de archivo 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'

Respuesta:

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

Eliminar un solo lead

DELETE /api/delete-lead/{leadId} elimina un solo lead capturado por su ID. El segmento de ruta es el leadId (el LeadID de list-leads); pasa también el Email del lead y su FlipbookID como parámetros de consulta.

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

Respuesta:

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

Eliminar leads en bloque

DELETE /api/delete-leads elimina leads en bloque por filtro. Se REQUIERE al menos UNO de FlipbookID / Email / DateFrom / DateTo: una llamada sin filtro se rechaza (no existe una vía para "eliminar todo"). La operación siempre está acotada al proveedor y devuelve { Result, Deleted (count) }. También limpia las filas hijas (registro de visualizaciones / clics en CTA / registro de exportación de hojas).

• FlipbookID — opcional; elimina solo los leads de este flipbook.
• Email — opcional; correo de coincidencia EXACTA.
• DateFrom — opcional; elimina los leads capturados en esta fecha o después (coincide con Lead.CreatedOn). Cualquier fecha analizable, p. ej. 2026-01-01 o 2026-01-01T00:00:00Z.
• DateTo — opcional; elimina los leads capturados en esta fecha o antes.

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

Respuesta:

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

Errores posibles

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key (o el encabezado Authorization: Bearer) esté presente y sea correcto.

Notas

• La eliminación en bloque requiere al menos un filtro (FlipbookID, Email, DateFrom o DateTo); una llamada sin filtro se rechaza — no existe una vía para "eliminar todo".
• La eliminación en bloque siempre está acotada al proveedor y también elimina las filas hijas relacionadas (registro de visualizaciones, clics en CTA, registro de exportación de hojas).
• Para obtener el ID de un lead y eliminarlo individualmente, primero llama a GET /api/list-leads.