FlipLink

リードを取得・削除する

リードと販売

フリップブックが集めたリード獲得の送信内容を、ページ送り・検索・CSVエクスポートで一覧表示し、リードを1件ずつ、またはフィルターで一括削除できます。

このディスカッションで使うAPI

このガイドに誤りや古い情報がありますか？

できること

これら3つのエンドポイントで、フリップブックが集めるリード獲得の送信内容を読み取り、整理できます。

  • すべてのフリップブック、または特定の1つのリードを、検索・ページ送り・CSVエクスポートで一覧表示する。
  • IDで1件のリードを削除する。
  • フィルター（フリップブック、メール、日付範囲）でリードを一括削除する。

始める前に

  • APIキー — X-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
  • すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
  • 1件のリードの削除は{leadId}パスセグメントを使い、さらにリードのEmailとFlipbookIDをクエリパラメーターとして渡します。一括削除にはパスパラメーターがなく、クエリパラメーターで絞り込みます。
  • これらのエンドポイントはリクエストボディを使いません。入力はすべてクエリ文字列のパラメーターです。

リードを一覧表示する

GET /api/list-leadsは、フリップブックが集めたリード獲得の送信内容を一覧表示します。Items[]に加え、（テーブルを描画するための）動的なColumns[]スキーマとTotalRecordCountを返します。ページ送りと、IsDownloadによるCSVエクスポートに対応しています。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
}

1件のリードを削除する

DELETE /api/delete-lead/{leadId}は、IDで1件の獲得済みリードを削除します。パスセグメントはleadId（list-leadsのLeadID）です。さらに、リードのEmailとそのFlipbookIDをクエリパラメーターとして渡します。

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のうち少なくとも1つが必須です。フィルターなしの呼び出しは拒否されます（「すべて削除」の経路はありません）。この操作は常にベンダー単位で行われ、{ Result, Deleted（件数） }を返します。また、子行（閲覧ログ／CTAクリック／シートエクスポートログ）も整理します。

  • FlipbookID — 任意。このフリップブックのリードのみを削除します。
  • 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。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Keyヘッダー（またはAuthorization: Bearerヘッダー）が存在し、正しいことを確認してください。

メモ

  • 一括削除には少なくとも1つのフィルター（FlipbookID、Email、DateFrom、DateTo）が必要です。フィルターなしの呼び出しは拒否されます。「すべて削除」の経路はありません。
  • 一括削除は常にベンダー単位で行われ、関連する子行（閲覧ログ、CTAクリック、シートエクスポートログ）も削除します。
  • 1件削除のためにリードのIDを取得するには、まずGET /api/list-leadsを呼び出してください。

関連ディスカッション

フリップブックを販売して売上を確認する