Получение и удаление лидов

Что можно сделать

Эти три эндпоинта позволяют читать и очищать заявки захвата лидов, которые собирают ваши флипбуки:

• Получить список лидов по всем вашим флипбукам или по конкретному, с поиском, постраничной разбивкой и экспортом в CSV.
• Удалить одного лида по его ID.
• Удалить лидов массово по фильтру (флипбук, email или диапазон дат).

Перед началом

• API-ключ — передаётся в заголовке X-Api-Key или как Authorization: Bearer YOUR_API_KEY.
• Все запросы идут на базовый URL https://go.fliplink.me.
• Удаление одного лида использует сегмент пути {leadId}, и вы также передаёте Email лида и FlipbookID как query-параметры. У массового удаления нет параметра пути — оно фильтрует через query-параметры.
• Эти эндпоинты не используют тело запроса; все входные данные — это параметры строки запроса.

Список лидов

GET /api/list-leads выводит список заявок захвата лидов, собранных вашими флипбуками. Он возвращает Items[] плюс динамическую схему Columns[] (для отрисовки таблицы) и TotalRecordCount. Он поддерживает постраничную разбивку и экспорт в CSV через IsDownload. Передавайте ItemIDs (ID флипбуков через запятую ИЛИ через вертикальную черту; пусто = все), чтобы ограничить результаты. При IsDownload=false (или пусто) вы получаете тело JSON, показанное ниже; IsDownload=true вместо этого возвращает экспорт 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'

Ответ:

{
  "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 /api/delete-lead/{leadId} удаляет одного захваченного лида по его ID. Сегмент пути — это leadId (LeadID из list-leads); также передавайте Email лида и его FlipbookID как 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'

Ответ:

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

Удалить лидов массово

DELETE /api/delete-leads массово удаляет лидов по фильтру. ХОТЯ БЫ ОДИН из FlipbookID / Email / DateFrom / DateTo ОБЯЗАТЕЛЕН — вызов без фильтра отклоняется (пути «удалить всё» нет). Операция всегда ограничена вендором и возвращает { Result, Deleted (количество) }. Она также очищает дочерние строки (журнал просмотров / клики по CTA / журнал экспорта в таблицу).

• FlipbookID — необязательно; удалить лидов только на этом флипбуке.
• Email — необязательно; ТОЧНОЕ совпадение email.
• DateFrom — необязательно; удалить лидов, захваченных в указанную дату или после неё (совпадает с Lead.CreatedOn). Любая распознаваемая дата, например 2026-01-01 или 2026-01-01T00:00:00Z.
• DateTo — необязательно; удалить лидов, захваченных в указанную дату или до неё.

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

Ответ:

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

Возможные ошибки

• Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key (или заголовок Authorization: Bearer) присутствует и указан верно.

Примечания

• Массовое удаление требует хотя бы одного фильтра (FlipbookID, Email, DateFrom или DateTo); вызов без фильтра отклоняется — пути «удалить всё» нет.
• Массовое удаление всегда ограничено вендором и также удаляет связанные дочерние строки (журнал просмотров, клики по CTA, журнал экспорта в таблицу).
• Чтобы получить ID лида для удаления по одному, сначала вызовите GET /api/list-leads.