Recuperar e excluir leads

O que você pode fazer

Estes três endpoints permitem ler e limpar os envios de captação de leads que seus flipbooks coletam:

• List — liste os leads de todos os seus flipbooks ou de um específico, com busca, paginação e exportação em CSV.
• Delete a single lead — exclua um único lead pelo ID dele.
• Delete leads in bulk — exclua leads em massa por filtro (flipbook, e-mail ou intervalo de datas).

Antes de começar

• Uma chave de API — enviada como cabeçalho X-Api-Key ou como Authorization: Bearer YOUR_API_KEY.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• A exclusão de um único lead usa um segmento de caminho {leadId}, e você também passa o Email e o FlipbookID do lead como parâmetros de query. A exclusão em massa não tem parâmetro de caminho — ela filtra via parâmetros de query.
• Estes endpoints não usam corpo de requisição; todas as entradas são parâmetros de query string.

List — liste os leads

GET /api/list-leads lista os envios de captação de leads coletados pelos seus flipbooks. Ele retorna Items[] mais um esquema dinâmico Columns[] (para renderizar uma tabela) e TotalRecordCount. Ele aceita paginação e exportação em CSV via IsDownload. Passe ItemIDs (IDs de flipbook delimitados por vírgula OU por barra vertical; vazio = todos) para escopar os resultados. Com IsDownload=false (ou vazio) você recebe o corpo JSON mostrado abaixo; IsDownload=true retorna um arquivo CSV de exportação.

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'

Resposta:

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

Delete a single lead — exclua um único lead

DELETE /api/delete-lead/{leadId} exclui um único lead capturado pelo ID dele. O segmento de caminho é o leadId (o LeadID do list-leads); passe também o Email do lead e o FlipbookID dele como parâmetros de 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'

Resposta:

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

Delete leads in bulk — exclua leads em massa

DELETE /api/delete-leads exclui leads em massa por filtro. PELO MENOS UM de FlipbookID / Email / DateFrom / DateTo é OBRIGATÓRIO — uma chamada sem filtro é rejeitada (não há um caminho de "excluir tudo"). A operação é sempre escopada ao vendor e retorna { Result, Deleted (contagem) }. Ela também limpa linhas filhas (log de visualizações / cliques em CTA / log de exportação para planilha).

• FlipbookID — opcional; exclui leads só deste flipbook.
• Email — opcional; e-mail com correspondência EXATA.
• DateFrom — opcional; exclui leads capturados nesta data ou depois (corresponde a Lead.CreatedOn). Qualquer data interpretável, por exemplo 2026-01-01 ou 2026-01-01T00:00:00Z.
• DateTo — opcional; exclui leads capturados nesta data ou antes.

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

Resposta:

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

Erros possíveis

• Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key (ou o cabeçalho Authorization: Bearer) está presente e correto.

Notas

• A exclusão em massa exige pelo menos um filtro (FlipbookID, Email, DateFrom ou DateTo); uma chamada sem filtro é rejeitada — não há um caminho de "excluir tudo".
• A exclusão em massa é sempre escopada ao vendor e também remove linhas filhas relacionadas (log de visualizações, cliques em CTA, log de exportação para planilha).
• Para obter o ID de um lead para exclusão individual, chame primeiro GET /api/list-leads.