FlipLink
開発者向け API · REST

FlipLink API リファレンス

フリップブックやドキュメントの作成、ビューアの設定、リードの獲得、カスタムドメインの管理を、すべてプログラムから行えます。API キーで認証し、すべてのエンドポイントをこのページから直接試せます。

API キーを取得ドキュメントを読む

ベース URL https://go.fliplink.me

キーを取得 →

はじめに

FlipLink の REST API を使うと、フリップブックやドキュメントをプログラムから作成・管理できます。PDF のアップロード、ビューアの設定、リードの獲得、カスタムドメインの管理などが可能です。すべてのエンドポイントは下記のベース URL からアクセスでき、API キーで認証します。

ベース URL
https://go.fliplink.me

認証

リクエストごとに API キーを送ってください。ヘッダーの形式は 2 通りに対応しています。HTTP クライアントに合わせて、どちらでも使えます。

認証ヘッダー
X-Api-Key: YOUR_API_KEY
# — or —
Authorization: Bearer YOUR_API_KEY

キーが欠けている、または無効な場合は HTTP 401（HTML の「Unauthorized」ページ。JSON ボディはないため、401 の際はパースしないでください）で拒否されます。キーが有効であれば、それ以外のエラーはすべて HTTP 200 と Result: ERROR で返ります（下記参照）。キーは秘密にしてください。エンドユーザーに配布するクライアント側コードには絶対に含めないでください。

レスポンス形式と結果タイプ

すべてのレスポンスは JSON で、トップレベルに Result フィールドを持ちます。値はちょうど 2 種類です。

  • "Result": "OK" — 成功です。読み取り系エンドポイントはペイロードを、書き込み系エンドポイントは人間向けの Message（例："Updated successfully"）を追加し、create/duplicate は新しい ID と URL を返します。
  • "Result": "ERROR" — 失敗です。理由を説明する Message が付きます。

重要: 非 200 の HTTP ステータスを使うのは、認証失敗（401）、サイズ超過のアップロード（413）、レート制限（429）だけです。それ以外（検証エラー、「見つからない」、業務ルール）はすべて HTTP 200 と Result: ERROR で返るため、ステータスだけでなく Result を確認してください。

ページング

一覧系エンドポイントは PageNo、PageSize、Offset のクエリパラメータを受け付けます。省略すると適切なデフォルトが使われます。

レート制限

各 API キーは 1 分あたり 300 リクエストに制限されます。ウィンドウは固定で、分の切り替わりごとにリセットされます（直近 60 秒のローリングではありません）。すべてのレスポンスは、現在の残量をヘッダーで返します。

レート制限ヘッダー
X-RateLimit-Limit: 300          # requests allowed per minute
X-RateLimit-Remaining: 287      # requests left in the current window
X-RateLimit-Reset: 1781962140   # Unix epoch (seconds) when the window resets

制限を超えると HTTP 429 が返ります。X-RateLimit-Reset まで待つ（またはバックオフして再試行する）とともに、X-RateLimit-Remaining を確認して上限を超えないようにしてください。

プラン上限と利用枠

フリップブックの利用枠は、create のレスポンスと get-subscription-details で Flipbooks_Count / Flipbooks_Max / Flipbooks_Left として返ります。最大アップロードサイズは MaxFileSizeMB で確認できます。

エラー

対処しておくべき主な状況です（各エンドポイントの下にも、それぞれの一覧があります）。

  • 401 — API キーが欠けている、または無効（HTML ページ、JSON なし）
  • 413 — アップロードがプランの最大ファイルサイズを超過
  • 429 — レート制限。バックオフして再試行してください
  • 200 + Result:ERROR — それ以外すべて。見つからない（"Item not found"）、検証エラー（"Unknown field(s) …"）、業務ルール（"This custom URL is already in use…"、"File is not a valid PDF"）

プロフィール

アカウント情報の取得

API キーが紐づくアカウントを返します。user/vendor の ID、名前、メールアドレス、ブランド、アプリ URL、プランの最大アップロードサイズ（MaxFileSizeMB）が含まれます。

GEThttps://go.fliplink.me/api/whoami

前提条件 — なし。これはルートとなる呼び出しです。API キーを認証する、他のすべてのエンドポイントの前提となる呼び出しです。

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連サブスクリプション詳細の取得プロフィールの取得
GET/api/whoami
curl -X GET 'https://go.fliplink.me/api/whoami' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "UserID": "10000",
  "VendorID": "20000",
  "Name": "Your Account",
  "Email": "you@example.com",
  "Brand": "Fliplink",
  "AppURL": "go.fliplink.me",
  "MaxFileSizeMB": 150
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

プロフィールの取得

API キーに対応するアカウントのプロフィールを返します。表示名、電話番号、プロフィール画像の URL が含まれます。

GEThttps://go.fliplink.me/api/get-profile
前提条件アカウント情報の取得(有効な API キー)→プロフィールの取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連プロフィールの設定（部分更新）アカウント情報の取得
GET/api/get-profile
curl -X GET 'https://go.fliplink.me/api/get-profile' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Name": "Your Account",
  "Phone": "",
  "ProfileImage": ""
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

プロフィールの設定（部分更新）

部分更新です。指定しなかったフィールドは既存の値のまま保持されます。少なくとも 1 つのフィールドが必要です。

PUThttps://go.fliplink.me/api/set-profile
前提条件アカウント情報の取得(有効な API キー)→プロフィールの設定（部分更新）

ボディパラメータ

Name例： Mark Stevens
Phonephone例： +14155550142
ProfileImageURL例： https://...

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連プロフィールの取得
PUT/api/set-profile
curl -X PUT 'https://go.fliplink.me/api/set-profile' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://...'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

ボディパラメータ

サブスクリプションと支払い

サブスクリプション詳細の取得

現在のプランと利用枠を返します。プラン名、ステータス、料金、次回請求日、最大ファイルサイズ、アイテム/CNAME の上限数、各種機能フラグが含まれます。

GEThttps://go.fliplink.me/api/get-subscription-details
前提条件アカウント情報の取得(有効な API キー)→サブスクリプション詳細の取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連支払い履歴の取得アカウント情報の取得
GET/api/get-subscription-details
curl -X GET 'https://go.fliplink.me/api/get-subscription-details' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Subscription": {
    "BrandName": "",
    "Name": "Your Account",
    "Mobile": "",
    "SubscriptionPlan": "LTD Individual",
    "SubscriptionFees": "USD 39.00",
    "Tax": "",
    "SubscriptionID": "#20000",
    "ActiveFrom": "12 Jun 2026",
    "Status": "Active",
    "NextInvoice": "01 Jan 2050",
    "Email": "you@example.com",
    "PhotoIMG": "/Content/assetsNew/media/avatars/blank.png",
    "MaxFileSizeBytes": 157286400,
    "MaxFileSize": "150",
    "MaxCNAME": "Unlimited",
    "AdvancedSharing": "Yes",
    "LeadEmailVerification": "Yes",
    "IsLTD": "Yes",
    "MaxItems": "200"
  }
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

支払い履歴の取得

課金履歴を返します。各プランの購入・更新ごとに、注文 ID、金額、プラン、日付、アイテム数が含まれます。

GEThttps://go.fliplink.me/api/list-payments
前提条件アカウント情報の取得(有効な API キー)→支払い履歴の取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連サブスクリプション詳細の取得
GET/api/list-payments
curl -X GET 'https://go.fliplink.me/api/list-payments' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "OrderID": "#10001",
      "Amount": "USD 39.00",
      "Plan": "LTD Individual / 822bf1b6",
      "Date": "12 Jun 2026",
      "DateIso": "2026-06-12T00:00:00+05:30",
      "InvoiceURL": "",
      "ItemCount": 100
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

アイテム — 作成

ファイルから作成

アップロードした PDF からフリップブック（またはドキュメント）を作成します。multipart/form-data で送信してください。ファイルが保存され、サムネイルが生成され、レコードが登録されます。

補足
- フリップブックとドキュメントのどちらになるかは、リクエストの Host ヘッダーで決まります。go.fliplink.me（デフォルト）はフリップブックを、go.doclink.me はドキュメントを返します。
- *_Count / *_Max / *_Left は、この作成後のプラン利用枠を反映します。
- 後続の呼び出し（set-meta、set-cta-primary、save-as-template など）には、返された ID を使ってください。
- 最大ファイルサイズはプランごとに異なります（who-am-i の MaxFileSizeMB を参照）。

POSThttps://go.fliplink.me/api/create-by-file
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成

ボディ（multipart/form-data）

Filefile—
Name例： My Document
Title例： My Title
DocTypeenumフリップブックまたはドキュメント。go.doclink.me では常にドキュメントとして扱われます。次のいずれか： Flipbook, Document

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連URL から作成単一アイテムの取得メタ情報の設定
POST/api/create-by-file
curl -X POST 'https://go.fliplink.me/api/create-by-file' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file' \
  -F 'Name=My Document' \
  -F 'Title=My Title' \
  -F 'DocType=Flipbook'
レスポンス例200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

ボディ（form-data）

URL から作成

PDF の URL からフリップブック（またはドキュメント）を作成します。サーバーが FileURL をダウンロードして S3 にアップロードし、サムネイルを生成してレコードを登録します。

補足
- フィールド名のプレフィックスが Flipbooks_* になるか Documents_* になるかは、リクエストの Host ヘッダーで決まります。go.fliplink.me（デフォルト）はフリップブックを、go.doclink.me はドキュメントを返します。
- *_Count / *_Max / *_Left は、この作成後のアカウントのプラン利用枠を反映します。
- ソース URL は 60 秒以内に応答する必要があります。応答が遅い、または到達できない場合は Source URL timed out after 60s. で失敗します。信頼性の低いソースの場合は /api/create-by-file の利用をおすすめします。

POSThttps://go.fliplink.me/api/create-by-url
前提条件アカウント情報の取得(有効な API キー)→URL から作成

ボディパラメータ

FileURLURL例： https://example.com/document.pdf
Name例： My Document
Title例： My Title
DocTypeenum例： Flipbook次のいずれか： Flipbook, Document

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200FileURL host is private / not allowed{ "Result": "ERROR", "Message": "FileURL host is not allowed." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連ファイルから作成単一アイテムの取得メタ情報の設定
POST/api/create-by-url
curl -X POST 'https://go.fliplink.me/api/create-by-url' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FileURL=https://example.com/document.pdf' \
  --data-urlencode 'Name=My Document' \
  --data-urlencode 'Title=My Title' \
  --data-urlencode 'DocType=Flipbook'
レスポンス例200 OK
{
  "Result": "OK",
  "ID": "90001",
  "URL": "https://go.fliplink.me/view/<slug>",
  "Flipbooks_Count": 12,
  "Flipbooks_Max": 200,
  "Flipbooks_Left": 188
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

ボディパラメータ

アイテム — 読み取り

単一アイテムの取得

ID を指定して、単一のフリップブック/ドキュメントの全レコードを返します。タイトル、各種 URL、閲覧数/リード数/販売数、フォルダ、ステータスフラグなど、保存されているすべての列が含まれます。全レコードは約 190 列を持つ `Item` オブジェクトにラップされて 返されます。以下の例は、その代表的な一部を抜粋したものです。

GEThttps://go.fliplink.me/api/get/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→単一アイテムの取得

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連URL から検索PDF URL の取得共有リンクの取得一覧の取得
GET/api/get/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "Name": "My Document",
    "Title": "My Title",
    "DocType": "Flipbook",
    "IsPublished": true,
    "Pages": 8,
    "Folder": "Marketing",
    "SkinName": "Light Wood",
    "CustomURL": "my-document-96216",
    "ValidTillDate": "",
    "NoOfViews": 42,
    "NoOfLeads": 3,
    "NoOfSales": 0,
    "IsForSale": false,
    "IsLeadCapture": true,
    "IsPasswordProtected": false,
    "BookLayout": 1,
    "ScrollBehaviour": 1,
    "IsRightToLeft": false,
    "CoverType": "1",
    "PageDepth": "1",
    "FullURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172",
    "EmbedURL": "https://go.fliplink.me/view/8BDB015E-1C2A-4625-8EF6-81263AB98172"
  }
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

URL から検索

公開 URL／共有 URL からフリップブックを検索し、その全レコードを返します（get と同じ形式です）。

GEThttps://go.fliplink.me/api/find-by-url
前提条件アカウント情報の取得(有効な API キー)→URL から検索

クエリパラメータ

URLURLビューアの完全な URL、CNAME の URL、または CustomURL のスラッグのみ。サーバーはパスの最後のセグメントをスラッグとして扱います。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連単一アイテムの取得共有リンクの取得
GET/api/find-by-url
curl -X GET 'https://go.fliplink.me/api/find-by-url?URL=https%3A%2F%2Fgo.fliplink.me%2Fview%2F%3Cslug%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 96216,
    "VendorID": "20000",
    "FilePDF": "/docs/20001/894abc58~demo_multipage.pdf",
    "Name": " coverage 20-Jun",
    "CreatedOn": "/Date(1781945608053)/",
    "NoOfViews": 1,
    "IsActive": true,
    "CustomURL": "your-flipbook-slug",
    "Title": "",
    "Description": " desc",
    "SkinID": -1,
    "LogoIMG": "",
    "LogoURL": "https://fliplink.me",
    "BackgroundIMG": "",
    "BackgroundDisplayFit": "",
    "BackgroundFillDirection": "",
    "ColorPanel": "#5A5F63",
    "ColorBackground": "#F2F2F2",
    "ColorLink": "#75869C",
    "FaviconIMG": "",
    "IsShare": true,
    "IsPrint": true,
    "IsDownload": false,
    "IsTextSelection": true,
    "IsThumbnails": true,
    "IsSound": false,
    "IsFullscreen": false,
    "IsZoom": false,
    "IsSearch": true,
    "IsPinnedThumbnails": false,
    "IsCTAButton": false,
    "CTAButtonText": "Buy",
    "CTAButtonColor": "#3366FF",
    "CTAButtonTextColor": "       ",
    "CTAButtonURL": "https://fliplink.me",
    "IsPasswordProtected": false,
    "Password": "",
    "IsLeadCapture": true,
    "LeadCaptureTitle": "",
    "IsLeadEmail": true,
    "IsLeadEmailMandatory": true,
    "IsLeadName": true,
    "IsLeadNameMandatory": false,
    "IsLeadPhone": false,
    "IsLeadPhoneMandatory": false,
    "IsLeadCompany": false,
    "IsLeadCompanyMandatory": false,
    "IsLeadDate": false,
    "IsLeadDateMandatory": false,
    "IsLeadCustom1": false,
    "IsLeadCustom1Mandatory": false,
    "Custom1Label": "",
    "IsLeadCustom2": false,
    "IsLeadCustom2Mandatory": false,
    "Custom2Label": "",
    "IsLeadPrivacyPolicy": false,
    "PrivacyPolicyURL": "",
    "IsLeadAllowSkip": true,
    "PageTurnMode": "Flip",
    "BookLayout": 1,
    "Shadowdepth": 1,
    "IsFixedZoomMode": false,
    "IsHardCover": false,
    "IsBookThickness": true,
    "IsLinkHighlight": true,
    "IsRightToLeft": false,
    "IMGPdf": "/Content/assets/media/users/no-image.png",
    "Pages": 8,
    "FacebookAnalyticsCode": "",
    "GoogleAnalyticsCode": "",
    "GoogleTagManager": "",
    "Folder": "-Folder",
    "PabblyWebhookURL_NewLead": "https://example.com/webhook-apitest",
    "TitleColor": "#3366FF",
    "CNAME": "",
    "IsNoIndex": false,
    "BackgroundMusic": "",
    "BackgroundMusicCustom": "",
    "AutoFlipInSecs": 0,
    "PwdTitle": "This is a private flipbook.\r\nTo view it, please enter the password.",
    "PwdPlaceholder": "Password",
    "PwdButton": "Submit",
    "LeadEmail": "Email",
    "LeadName": "Name",
    "LeadPhone": "Phone",
    "LeadCompany": "Company",
    "LeadDate": "Date",
    "LeadButton": "Submit",
    "SkinName": "Light Wood",
    "DocType": "Flipbook",
    "IsSendEmailOnView": false,
    "LeadFormAfterPages": 0,
    "CustomLoadingText": " loading",
    "IsShareButtons": true,
    "IsNotes": false,
    "IsCTAButton2": false,
    "CTAButtonText2": "More",
    "CTAButtonColor2": "#3366FF",
    "CTAButtonTextColor2": "       ",
    "CTAButtonURL2": "",
    "IsVerifyEmail": false,
    "IsVerifyMobile": false,
    "TwillioAPIKey": "",
    "IsShowControls": true,
    "NotificationsEmail": "antifragiletech@gmail.com",
    "GoogleSheetURL": "",
    "GoogleSheetIDKey": "",
    "GoogleSheetName": "",
    "PrivacyPolicyText": "",
    "PageDepth": "1",
    "CoverType": "1",
    "IsPublished": true,
    "LeadPhoneCountry": "",
    "LeadAfterPages": 0,
    "EmailsAllowed": "",
    "EmailVerifyTitleText": "antifragiletech@gmail.com",
    "EmailVerifyButtonText": "antifragiletech@gmail.com",
    "LeadSkipText": "",
    "OrdPos": 1,
    "IsStarred": false,
    "IsShowLogoMobile": true,
    "PreviewPDF": "",
    "IsForSale": false,
    "SaleCurr": "USD",
    "SaleAmount": 10,
    "SalePageTitle": "",
    "SaleAccessPageTitle": "",
    "SalePurchaseButtonText": "",
    "SaleButtonText": "",
    "SaleAccessButtonText": "",
    "SaleButtonColor": "#3366FF",
    "SaleGatewayName": "",
    "SaleGatewayKey": "",
    "SaleGatewaySecret": "",
    "EmailLeadSubject": "",
    "EmailLeadBody": " body",
    "EmailViewSubject": "antifragiletech@gmail.com",
    "EmailViewBody": "antifragiletech@gmail.com",
    "EmailSaleSubject": "antifragiletech@gmail.com",
    "EmailSaleBody": "antifragiletech@gmail.com",
    "TopLeft": "",
    "TopRight": "",
    "BottomLeft": "",
    "BottomRight": "",
    "IsCTAHiddenInPreview": false,
    "IsApprovalButton": false,
    "ApprovalButtonText": "Approve Document",
    "ApprovalButtonColor": "#000000",
    "ApprovalButtonTextColor": "#FFFFFF",
    "EmailApproveRequestSubject": "Document Approval Request: ##DOCUMENT_TITLE##",
    "EmailApproveRequestBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveRemindSubject": "Pending Document Approval: ##DOCUMENT_TITLE##",
    "EmailApproveRemindBody": "<p dir=\"ltr\" style=\"line-height: 1.38; margin-top: 0pt; margin-bottom: 0pt;\"><span style=\"color: #222222; font-family...",
    "EmailApproveSubmitSubject": "Document Approved: ##DOCUMENT_TITLE##",
    "EmailApproveSubmitBody": "<p>Hi,</p>\n<p>We are pleased to inform you that the following document has been approved:</p>\n<p>Name: <strong>##DOCU...",
    "IsBackgroundMusicLoop": false,
    "IsNavFirstLast": true,
    "IsShareFacebook": true,
    "IsShareTwitter": true,
    "IsShareWhatsApp": true,
    "IsShareTelegram": false,
    "IsShareLinkedIn": false,
    "IsSharePinterest": false,
    "IsShareReddit": false,
    "IsShareTumblr": false,
    "IsShareMessenger": false,
    "IsShareEmail": false,
    "IsShareLine": false,
    "IsShareWeChat": false,
    "IsShareInstagram": false,
    "IsShareFlipboard": false,
    "IsShareGeneral": false,
    "ScrollBehaviour": 1,
    "AIProvider": "",
    "AIKey": "",
    "IsVA": false,
    "VAButtonText": "",
    "VAButtonColor": "#3366FF",
    "VAButtonTextColor": "#3366FF",
    "VAText": "",
    "VAEmbeddings": "",
    "VAButtonStatus1": "0",
    "VAButtonStatus2": "0",
    "VAButtonStatus3": "0",
    "VAButtonStatus4": "0",
    "FrontPDF": "/docs/20001/f9496e75~dummy.pdf",
    "MiddlePDF": "/docs/20001/0b14ad4d~demo_multipage.pdf",
    "BackPDF": "/docs/20001/68504e6d~dummy.pdf",
    "URLPrefix": "https://go.fliplink.me/view/",
    "NoOfSales": 0,
    "WebhookURL_NewLead": "https://example.com/webhook-apitest",
    "CreatedOnIso": "2026-06-20T14:23:28+05:30"
  }
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

一覧の取得

フリップブック/ドキュメントをページング（PageNo/PageSize）付きで一覧表示します。各アイテムには、各 ID、タイトル、各種 URL、閲覧数/リード数/販売数、フォルダ、ステータスフラグが含まれます。

GEThttps://go.fliplink.me/api/list
前提条件アカウント情報の取得(有効な API キー)→一覧の取得

クエリパラメータ

Folder—
SearchText—
PageNonumber例： 1
PageSizenumber例： 25
Offsetnumber例： 0
SortByenum任意。`Name`、`DocType`、`CreatedOn`、`NoOfViews`、`NoOfLeads` のいずれか。空の場合はデフォルトの並び順、不明な値の場合もデフォルトに戻ります。次のいずれか： Name, DocType, CreatedOn, NoOfViews, NoOfLeads
SortOrderenum任意。`ASC` または `DESC`。SortBy が空の場合は無視されます。不明な値は通知なくデフォルトに戻ります。次のいずれか： ASC, DESC

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連単一アイテムの取得フォルダの一覧取得
GET/api/list
curl -X GET 'https://go.fliplink.me/api/list?Folder=%3CFolder%3E&SearchText=%3CSearchText%3E&PageNo=1&PageSize=25&Offset=0&SortBy=%3CSortBy%3E&SortOrder=%3CSortOrder%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 93286,
      "Name": "INSPECT matrix Document - Copy 000",
      "Title": "MX Title",
      "CreatedOn": "Jun 12 2026  4:48PM",
      "CreatedOnIso": "2026-06-12T22:18:49.723+05:30",
      "CreatedDate": "Jun 12, 2026",
      "CreatedTime": " 4:48PM",
      "ValidTillDate": "",
      "NoOfViews": 0,
      "CustomURL": "0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "Password": "",
      "FilePDF": "/docs/20001/0DF318DC~dummy.pdf",
      "NoOfLeads": 0,
      "NoOfSales": 0,
      "FullURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "EmbedURL": "https://go.fliplink.me/view/0DF318DC-1CDB-4851-9620-76D3CB8F43C7",
      "IMGPdf": "/Content/assets/media/users/no-image.png",
      "Pages": 0,
      "IsUnpublished": "",
      "Folder": "",
      "IsTemplate": false,
      "CNAMEMessage": "",
      "DocType": "Document",
      "DocTypeColor": "danger",
      "SSL": "No",
      "CompressDataKey": "",
      "Optimised": "",
      "IsPinnedThumbnails": true,
      "IsApprovalButton": true,
      "NoOfApprovals": 0,
      "FrontPDF": "/docs/20001/730d7569~dummy.pdf",
      "MiddlePDF": "/docs/20001/4b34cbea~dummy.pdf",
      "BackPDF": "/docs/20001/e4454ad1~dummy.pdf"
    }
  ],
  "TotalRecordCount": 14,
  "TotalItems": 14,
  "UserItems": 14,
  "PageSize": 10,
  "Capped": false
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

PDF URL の取得

アイテムのメイン PDF の公開 S3 URL を返します（表紙/裏表紙でラップされている場合はマージ済みの PDF）。

GEThttps://go.fliplink.me/api/get-pdf/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→PDF URL の取得

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連単一アイテムの取得表紙/裏表紙の解除表紙/裏表紙の設定（ファイル）
GET/api/get-pdf/{flipbookId}
curl -X GET 'https://go.fliplink.me/api/get-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

アイテム — 変更

複製

フリップブックのサーバー側コピーを 1 つ以上作成します。各コピーには新しい ID と共有用の URL が割り当てられます。一度に最大 20 件まで複製できます（Count）。

POSThttps://go.fliplink.me/api/duplicate/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→複製

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Countnumber1〜500（サーバー側で範囲内に丸められます）

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連単一アイテムの取得ファイルから作成
POST/api/duplicate/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/duplicate/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Count=3'
レスポンス例200 OK
{
  "Result": "OK",
  "Count": 1,
  "Items": [
    {
      "ID": "93213",
      "URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

PDF の差し替え（ファイル）

マルチパートでアップロードします。表紙/裏表紙が設定されている場合は、自動的に再マージされます。

PUThttps://go.fliplink.me/api/replace-pdf/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→PDF の差し替え（ファイル）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディ（multipart/form-data）

Filefile—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連PDF の差し替え（URL）表紙/裏表紙の設定（ファイル）表紙/裏表紙の解除PDF URL の取得
PUT/api/replace-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@/path/to/file'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディ（form-data）

PDF の差し替え（URL）

既存のフリップブックの PDF を、指定した URL からサーバーがダウンロードした PDF に差し替えます。フリップブックの ID、設定、共有リンクはそのまま保持されます。

PUThttps://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→PDF の差し替え（URL）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

FileURL例： https://example.com/new.pdf

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連PDF の差し替え（ファイル）表紙/裏表紙の設定（URL）PDF URL の取得
PUT/api/replace-pdf-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'File=https://example.com/new.pdf'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

テンプレートとして保存（切り替え）

フリップブックを再利用可能なテンプレートとしてマークするか（Status=true）、テンプレートから外します（Status=false）。テンプレートは list-templates に表示され、新しいフリップブックの土台として使えます。

PUThttps://go.fliplink.me/api/save-as-template/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→テンプレートとして保存（切り替え）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Statustrue | falsetrue/false。省略した場合のデフォルトは true です。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連テンプレートの一覧取得ファイルから作成
PUT/api/save-as-template/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/save-as-template/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Saved as template"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

フォルダへの割り当て

整理のためにフリップブックをフォルダへ移動します。フォルダはオンデマンドで作成されます。 まだ存在しないフォルダ名に割り当てると、そのフォルダが自動的に作成されます（別途「フォルダを作成する」呼び出しはありません）。Folder を空で送ると、フリップブックをフォルダから外します。フォルダは少なくとも 1 つのフリップブックが入っている間だけ存在するため、最後のフリップブックを外すと list-folders から消えます。フォルダ名には / を含めることができます（例：Marketing/Q2）。

PUThttps://go.fliplink.me/api/assign-to-folder/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→フォルダへの割り当て

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Folderフリップブックの移動先となるフォルダ名。存在しなければ作成されます（または list-folders の名前を再利用します）。割り当てを解除するには空で送ってください。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連フォルダの一覧取得チームメンバーの設定（作成または更新）
PUT/api/assign-to-folder/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

表紙/裏表紙の設定（ファイル）

Front/Back はどちらか一方、または両方とも任意ですが、少なくとも 1 つは必要です。既存のメイン PDF と再マージされます。

PUThttps://go.fliplink.me/api/set-front-back-page/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→表紙/裏表紙の設定（ファイル）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディ（multipart/form-data）

Frontfile—
Backfile—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Uploaded file is not a readable PDF{ "Result": "ERROR", "Message": "File is not a valid PDF." }
413Upload exceeds the plan's max file size{ "Result": "ERROR", "Message": "File exceeds the maximum allowed upload size." }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連表紙/裏表紙の設定（URL）表紙/裏表紙の解除PDF の差し替え（ファイル）PDF URL の取得
PUT/api/set-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディ（form-data）

表紙/裏表紙の設定（URL）

set-front-back-page の URL 版です。アップロードしたファイルの代わりに、リモートの PDF URL から表紙/裏表紙を設定します。

PUThttps://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→表紙/裏表紙の設定（URL）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

FrontURL例： https://example.com/front.pdf
BackURL例： https://example.com/back.pdf

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連表紙/裏表紙の設定（ファイル）表紙/裏表紙の解除PDF URL の取得
PUT/api/set-front-back-page-by-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

表紙/裏表紙の解除

表紙/裏表紙のラップを解除し、FilePDF をラップ前のコア PDF（MiddlePDF）に戻します。冪等です。ラップのないフリップブックでは OK を返し、何も変更しません。{ Result, Message, URL（コア PDF の S3 URL） } を返します。古いマージ済み/表紙/裏表紙の S3 オブジェクトは削除されません。

PUThttps://go.fliplink.me/api/clear-front-back-page/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→表紙/裏表紙の解除

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連表紙/裏表紙の設定（ファイル）PDF URL の取得
PUT/api/clear-front-back-page/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Pages updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

有効期限の設定／解除

フリップブックの自動有効期限を設定または解除します。Days と Hours を整数で送ってください。Days=-1, Hours=0 で有効期限を完全に解除します。

PUThttps://go.fliplink.me/api/set-expiry/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→有効期限の設定／解除

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Daysnumber有効期限を解除するには -1 を指定します
Hoursnumber任意、デフォルトは 0

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連ピン留め（切り替え）公開状態の設定（公開／非公開）
PUT/api/set-expiry/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-expiry/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

ピン留め（切り替え）

フリップブックをピン留め（スター状態）したり解除したりして、ダッシュボードの先頭に並ぶようにします。

PUThttps://go.fliplink.me/api/set-pin/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→ピン留め（切り替え）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連一覧の取得
PUT/api/set-pin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-pin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

アイテム — 削除

削除

フリップブックのデータベースレコードを完全に削除します。注意：元となる S3 ファイルは自動的には削除されません。

DELETEhttps://go.fliplink.me/api/delete/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→削除

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードの一括削除一覧の取得
DELETE/api/delete/{flipbookId}
curl -X DELETE 'https://go.fliplink.me/api/delete/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Item has been deleted successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

CNAME（カスタムドメイン）

CNAME の追加

すでに有効化されたカスタムドメイン（CNAME）をフリップブックに紐づけます。ドメインは、まず Web ダッシュボードで追加・認証する必要があります（その際に DNS と SSL がプロビジョニングされます）。このエンドポイントは紐づけを保存するだけで、DNS の認証や証明書の発行は行いません。

前提条件:
- CNAME がアカウントにすでに存在している必要があります（ダッシュボードから追加）。存在しない場合：Please add CNAME <domain> to your account using the web dashboard. Only activated CNAMEs are allowed to be created via API.
- プランの CNAME 上限以内である必要があります。

パラメータ:
- CNAME（必須）— 完全なホスト名。例：docs.example.com
- IsCloudflare（任意、デフォルト 0）。

POSThttps://go.fliplink.me/api/add-cname/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→CNAME の追加

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

CNAME例： docs.example.com
IsCloudflaretrue | false任意。0（デフォルト）または 1。DNS が Cloudflare のプロキシ経由になっている場合は 1 を指定してください。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連CNAME の一覧取得CNAME の削除カスタム URL の設定
POST/api/add-cname/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/add-cname/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CNAME=docs.example.com' \
  --data-urlencode 'IsCloudflare=0'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

CNAME の一覧取得

呼び出し元のすべてのカスタム CNAME を返します。各アイテム：{ CNAME, Documents（有効なフリップブック数）, FlipbookIDs（その CNAME に紐づく有効なフリップブック ID の配列） }。

GEThttps://go.fliplink.me/api/list-cnames
前提条件アカウント情報の取得(有効な API キー)→CNAME の一覧取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連CNAME の追加CNAME の削除
GET/api/list-cnames
curl -X GET 'https://go.fliplink.me/api/list-cnames' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "CNAME": "ttr.antifragile.ae",
      "Documents": 1,
      "FlipbookIDs": [
        93270
      ]
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

CNAME の削除

カスタムドメイン（CNAME）の紐づけを、フリップブックの 1 件またはすべてから解除します。モードは 2 種類あります。

  • 一括（デフォルト）：CNAME=<host> を渡し、FlipbookID を空にします。所有するすべてのフリップブックからその CNAME を解除します。
  • フリップブック単位：FlipbookID=<id> を渡します。CNAME はそのフリップブックから参照されます。行ごとの「CNAME を解除」操作にはこちらを使ってください。

レスポンス（フリップブック単位）: { "Result": "OK", "Message": "CNAME removed from flipbook successfully" }
レスポンス（一括）: { "Result": "OK", "Message": "CNAME removed successfully" }
両方とも欠けている場合: { "Result": "ERROR", "Message": "CNAME or FlipbookID is required" }

注意: ホスト名にドットが含まれるため、CNAME は URL のセグメントではなくクエリパラメータとして渡してください。

DELETEhttps://go.fliplink.me/api/delete-cname
前提条件アカウント情報の取得(有効な API キー)→CNAME の一覧取得(CNAME / FlipbookID を確認する)→CNAME の削除

クエリパラメータ

CNAME一括モードでは必須です（所有するすべてのフリップブックからその CNAME を解除します）。FlipbookID > 0 の場合は無視され、CNAME はそのフリップブックから取得されます。
FlipbookIDnumber任意。0 より大きいフリップブック ID を渡すと、その 1 件のフリップブックからのみ CNAME を解除します（フリップブック単位モード）。一括モード（すべてから解除）にするには、空にするか省略するか 0 にしてください。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連CNAME の追加CNAME の一覧取得
DELETE/api/delete-cname
curl -X DELETE 'https://go.fliplink.me/api/delete-cname?CNAME=docs.example.com&FlipbookID=%3CFlipbookID%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

フォルダ

フォルダの一覧取得

フォルダの一覧を、それぞれ { Folder（名前）, URL（フォルダの GUID） } の形式で返します。フォルダはフリップブックの割り当て（assign-to-folder で作成）から導出されるため、空のフォルダは一覧に表示されません。フォルダ名は、assign-to-folder（フリップブックの配置）や set-team-member（チームメンバーのアクセス範囲の指定）で利用します。

GEThttps://go.fliplink.me/api/list-folders
前提条件アカウント情報の取得(有効な API キー)→フォルダの一覧取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連フォルダへの割り当てチームメンバーの設定（作成または更新）
GET/api/list-folders
curl -X GET 'https://go.fliplink.me/api/list-folders' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

チームメンバー

チームメンバーの一覧取得

アカウントのチームメンバー（ベンダーユーザー）を、アクセス情報とともに一覧表示します。各メンバーに割り当てられたフォルダ も含まれます。パスワードは返されません。IsActive で絞り込めます。

GEThttps://go.fliplink.me/api/list-team-members
前提条件アカウント情報の取得(有効な API キー)→チームメンバーの一覧取得

クエリパラメータ

IsActivetrue | false1=有効（デフォルト）、0=無効

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連チームメンバーの設定（作成または更新）チームメンバーの取得チームメンバーの有効化チームメンバーの削除
GET/api/list-team-members
curl -X GET 'https://go.fliplink.me/api/list-team-members?IsActive=1' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": 45452,
      "Name": "Jane Doe",
      "Email": "member@example.com",
      "IsActive": "True",
      "PhotoIMG": "",
      "Total": 0
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

チームメンバーの取得

メンバー ID（list-team-members で得られる ID）を指定して、単一のチームメンバーを返します。名前、メールアドレス、有効ステータス、そのメンバーに割り当てられたフォルダ が含まれます。チームメンバーは set-team-member で設定されたフォルダ（Folders フィールド）に制限されるため、それらのフォルダ内のフリップブックにのみアクセスできます。パスワードは返されません。memberId はチームメンバーの ID（List Team Members から取得）であり、フリップブックの ID ではありません。フリップブックの ID を渡すと「Team member not found」が返ります。メンバーは Item オブジェクトにラップされて返されます。Folders はアクセス可能なフォルダのカンマ区切りリストです（空の場合はフォルダ制限なし）。

GEThttps://go.fliplink.me/api/get-team-member/{memberId}
前提条件アカウント情報の取得(有効な API キー)→チームメンバーの設定（作成または更新）(先にメンバーを作成する)→チームメンバーの取得

パスパラメータ

memberIdnumberチームメンバーの ID（list-team-members から取得）。フリップブックの ID ではありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200No team member with that ID (e.g. you passed a flipbook ID){ "Result": "ERROR", "Message": "Team member not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連チームメンバーの一覧取得チームメンバーの設定（作成または更新）フォルダの一覧取得
GET/api/get-team-member/{memberId}
curl -X GET 'https://go.fliplink.me/api/get-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Item": {
    "ID": 45452,
    "Email": "member@example.com",
    "Name": "Jane Doe",
    "Phone": "",
    "PhotoIMG": "",
    "IsEmailVerified": false,
    "Folders": "Marketing,Sales"
  }
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

チームメンバーの設定（作成または更新）

新しいチームメンバー（ベンダーユーザー）を作成するか、既存のメンバーを更新します。アカウントにアクセスできる人と、Folders フィールドを通じて そのメンバーが制限されるフォルダ を管理できます（メンバーは割り当てられたフォルダ内のフリップブックしか見られません）。成功すると監査ログのエントリが書き込まれます。

よくある間違い: メンバーの名前は単一の Name フィールドです。FirstName/LastName はありません。Folders は List Folders から取得したフォルダ名の カンマ区切り リストです（例：Marketing,Sales）。フォルダ制限を設けない場合は空にしてください。メンバーの作成に成功すると { Result:"OK", Message:"Team member created" } が返ります（更新パス — ID を指定した場合 — では「Updated successfully」が返ります）。メンバーのメールアドレスは既存の FlipLink ユーザーのものと重複してはならず、+ エイリアス付きのメールは拒否されます。

POSThttps://go.fliplink.me/api/set-team-member
前提条件アカウント情報の取得(有効な API キー)→フォルダの一覧取得(Folders スコープ用の名前)→チームメンバーの設定（作成または更新）

ボディパラメータ

Name例： Jane
Emailemail例： jane@example.com
IDnumber作成するには省略するか -1 を指定します。更新するには 0 より大きい値を指定します。
Password平文。サーバー側で暗号化されます。更新時に空にすると既存のものが保持されます。
ProfileImageURL—
Foldersこのメンバーを制限するフォルダ。フォルダ名（list-folders から取得）の区切り付きリストです。メンバーはこれらのフォルダ内のフリップブックにのみアクセスできます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連チームメンバーの一覧取得チームメンバーの取得チームメンバーの有効化チームメンバーの削除フォルダの一覧取得
POST/api/set-team-member
curl -X POST 'https://go.fliplink.me/api/set-team-member' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Jane' \
  --data-urlencode 'Email=jane@example.com' \
  --data-urlencode 'ID=-1' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'ProfileImage=<ProfileImage>' \
  --data-urlencode 'Folders=<Folders>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Team member created"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

ボディパラメータ

チームメンバーの有効化

チームメンバーを有効化または無効化し、サインインしてアカウントにアクセスできるかどうかを管理します。

PUThttps://go.fliplink.me/api/set-team-member-active/{memberId}
前提条件アカウント情報の取得(有効な API キー)→チームメンバーの設定（作成または更新）(先にメンバーを作成する)→チームメンバーの有効化

パスパラメータ

memberIdnumberチームメンバーの ID（list-team-members から取得）。フリップブックの ID ではありません。

ボディパラメータ

IsActivetrue | false例： true

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連チームメンバーの一覧取得チームメンバーの設定（作成または更新）チームメンバーの削除
PUT/api/set-team-member-active/{memberId}
curl -X PUT 'https://go.fliplink.me/api/set-team-member-active/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsActive=true'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

チームメンバーの削除

論理削除（無効化）です。 チームメンバーが物理削除されることはありません。これはメンバーを無効化します（IsActive=false を指定した set-team-member-active の REST エイリアスです）。支払い履歴や監査の参照はそのまま残り、後から PUT /api/set-team-member-active（IsActive=true）で再有効化できます。

レスポンス: { "Result": "OK", "Message": "Team member deactivated" }。

DELETEhttps://go.fliplink.me/api/delete-team-member/{memberId}
前提条件アカウント情報の取得(有効な API キー)→チームメンバーの設定（作成または更新）(先にメンバーを作成する)→チームメンバーの削除

パスパラメータ

memberIdnumberチームメンバーの ID（list-team-members から取得）。フリップブックの ID ではありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連チームメンバーの有効化チームメンバーの一覧取得
DELETE/api/delete-team-member/{memberId}
curl -X DELETE 'https://go.fliplink.me/api/delete-team-member/{memberId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Team member deactivated"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

リードと販売

リードの一覧取得

フリップブックで収集したリード獲得フォームの送信内容を一覧表示します。Items[] に加えて、テーブルを描画するための動的な Columns[] スキーマと TotalRecordCount を返します。ページングと、IsDownload による CSV エクスポートに対応しています。

GEThttps://go.fliplink.me/api/list-leads
前提条件アカウント情報の取得(有効な API キー)→リードの一覧取得

クエリパラメータ

ItemIDsカンマまたはパイプ区切りのフリップブック ID（空の場合はすべて）
SearchText—
PageNonumber例： 1
Offsetnumber例： 0
IsDownloadtrue | false例： true

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードの削除リードの一括削除リード獲得の設定（基本）
GET/api/list-leads
curl -X GET 'https://go.fliplink.me/api/list-leads?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "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
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

販売の一覧取得

フリップブックの販売/購入レコード（購入者のメール、フリップブック、金額、日付）と、販売テーブルの列定義を一覧表示します。ページングと、IsDownload による CSV エクスポートに対応しています。

GEThttps://go.fliplink.me/api/list-sales
前提条件アカウント情報の取得(有効な API キー)→販売の一覧取得

クエリパラメータ

ItemIDs—
SearchText—
PageNonumber例： 1
Offsetnumber例： 0
IsDownloadtrue | false例： true
IsAbandonedtrue | falsetrue → 完了済みの販売ではなく、カゴ落ちした販売を返します

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連販売設定フリップブック購入の登録
GET/api/list-sales
curl -X GET 'https://go.fliplink.me/api/list-sales?ItemIDs=%3CItemIDs%3E&SearchText=%3CSearchText%3E&PageNo=1&Offset=0&IsDownload=true&IsAbandoned=false' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "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
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

リードの削除

ID を指定して、収集した単一のリードを削除します。パスのセグメントは leadId です。あわせてリードの Email と FlipbookID をクエリパラメータとして渡してください。

DELETEhttps://go.fliplink.me/api/delete-lead/{leadId}
前提条件アカウント情報の取得(有効な API キー)→リードの一覧取得(リード ID を取得する)→リードの削除

パスパラメータ

leadIdnumberリードの ID（list-leads の LeadID）。

クエリパラメータ

Emailemail例： foo@example.com
FlipbookIDnumber例： {{flipbookId}}

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードの一覧取得リードの一括削除
DELETE/api/delete-lead/{leadId}
curl -X DELETE 'https://go.fliplink.me/api/delete-lead/{leadId}?Email=foo%40example.com&FlipbookID=%7B%7BflipbookId%7D%7D' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Deleted successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

クエリパラメータ

リードの一括削除

フィルタを指定してリードを一括削除します。FlipbookID/Email/DateFrom/DateTo のうち少なくとも 1 つが必須です。フィルタなしの呼び出しは拒否されます（「すべて削除」の手段はありません）。常にベンダー単位にスコープされます。{ Result, Deleted（件数） } を返します。子レコード（閲覧ログ／CTA クリック／シートエクスポートログ）もあわせて削除します。

DELETEhttps://go.fliplink.me/api/delete-leads
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(FlipbookID でスコープを絞る)→リードの一括削除

クエリパラメータ

FlipbookIDnumber任意。このフリップブックのリードのみを削除します。
Emailemail任意。完全一致のメールアドレス。
DateFrom任意。この日付以降に収集されたリードを削除します（Lead.CreatedOn と照合）。解析可能な日付であれば何でも構いません。例：2026-01-01 や 2026-01-01T00:00:00Z。
DateTo任意。この日付以前に収集されたリードを削除します。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードの一覧取得リードの削除
DELETE/api/delete-leads
curl -X DELETE 'https://go.fliplink.me/api/delete-leads?FlipbookID=%7B%7BflipbookId%7D%7D&Email=%3CEmail%3E&DateFrom=%3CDateFrom%3E&DateTo=%3CDateTo%3E' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Deleted": 12,
  "Message": "12 lead(s) deleted."
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

フリップブック購入の登録

完了したフリップブックの販売（購入）を記録します。FlipLink の Stripe チェックアウトを経由せず、独自の決済フローで行われた購入を記録するのに使えます。

パスパラメータ: {flipbookId} — 購入済みとしてマークするフリップブック。

ボディ（urlencoded）:
- Email — 購入者のメール（必須）
- PaymentRef — 決済ゲートウェイの参照。例：Stripe の PaymentIntent ID（必須）

レスポンス（成功）: { "Result": "OK", "Message": "Purchase recorded successfully" }
レスポンス（エラー）: { "Result": "ERROR", "Message": "Email is required." } / "PaymentRef is required."

よくある間違い: PaymentRef を送ってください。Amount/Currency は送らないでください。これらは決済参照からサーバー側で導出されます。

POSThttps://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→フリップブック購入の登録

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Emailemail購入者のメールアドレス（必須）。
PaymentRefゲートウェイの決済参照（必須）。Stripe の場合は PaymentIntent ID（`pi_...`）です。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連販売設定販売ゲートウェイの設定販売の一覧取得
POST/api/set-flipbook-purchase/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/set-flipbook-purchase/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Email=customer@example.com' \
  --data-urlencode 'PaymentRef=pi_3O1234567890abcdef'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Purchase recorded successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

ルックアップ

テンプレートの一覧取得

アカウントに保存された再利用可能なフリップブックテンプレートを一覧表示します。DocType で絞り込めます（0 = すべて）。テンプレートの ID は save-as-template や各作成フローで利用します。

GEThttps://go.fliplink.me/api/list-templates
前提条件アカウント情報の取得(有効な API キー)→テンプレートの一覧取得

クエリパラメータ

DocTypenumber0 = フリップブック（デフォルト）、1 = ドキュメント

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連テンプレートとして保存（切り替え）ファイルから作成
GET/api/list-templates
curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

スキンの一覧取得

利用可能なビューアのスキン/テーマを一覧表示します。各行には、そのスキンに付属する背景の URL が含まれます。スキンの名前は set-skin で利用します。

GEThttps://go.fliplink.me/api/list-skins
前提条件アカウント情報の取得(有効な API キー)→スキンの一覧取得

クエリパラメータ

Typetrue | false0=フリップブックのスキン、1=ドキュメントのスキン

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連スキンの設定
GET/api/list-skins
curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

クエリパラメータ

通貨の一覧取得

フリップブックを販売する際に選べる通貨（販売/チェックアウト設定用）を一覧表示します。

GEThttps://go.fliplink.me/api/list-currencies
前提条件アカウント情報の取得(有効な API キー)→通貨の一覧取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連販売設定
GET/api/list-currencies
curl -X GET 'https://go.fliplink.me/api/list-currencies' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

背景音楽の一覧取得

フリップブックのビューアに設定できる、組み込みの背景音楽トラックを一覧表示します。

GEThttps://go.fliplink.me/api/list-background-music
前提条件アカウント情報の取得(有効な API キー)→背景音楽の一覧取得

パラメータはありません。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連背景音楽の設定
GET/api/list-background-music
curl -X GET 'https://go.fliplink.me/api/list-background-music' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

セクション — ブランディングとコンテンツ

メタ情報の設定

フリップブックのタイトルと SEO メタ情報を設定します。Title、Description、TitleColor、IsPublished フラグが対象です。

注意: これは Title/Description/TitleColor を上書きします。公開状態だけを変更する場合は set-published を使ってください。

PUThttps://go.fliplink.me/api/set-meta/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→メタ情報の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

Title—
Description—
TitleColor—
IsPublishedtrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連公開状態の設定（公開／非公開）
PUT/api/set-meta/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-meta/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=<Title>' \
  --data-urlencode 'Description=<Description>' \
  --data-urlencode 'TitleColor=<TitleColor>' \
  --data-urlencode 'IsPublished=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

公開状態の設定（公開／非公開）

フリップブックを公開または非公開にします。公開フラグだけを切り替え、Title/Description/TitleColor はそのまま保持します（set-meta とは異なります）。create-by-file で非公開のまま作成されたフリップブックを（再）公開するときなどに使えます。

PUThttps://go.fliplink.me/api/set-published/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→公開状態の設定（公開／非公開）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsPublishedtrue | falsetrue/1 = 公開、false/0 = 非公開（必須）。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連メタ情報の設定
PUT/api/set-published/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-published/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

スキンの設定

フリップブックにビューアのスキン/テーマを適用します。サーバーがスキン名をその ID に解決します。

よくある間違い: フィールドは SkinName（list-skins で得られる文字列）であり、数値の ID ではありません。

PUThttps://go.fliplink.me/api/set-skin/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→スキンの一覧取得(SkinName を選ぶ)→スキンの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

SkinName/api/list-skins の Name 列から取得

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連スキンの一覧取得
PUT/api/set-skin/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-skin/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName=<SkinName>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

背景画像の設定

指定した URL からビューアの背景画像を設定します（組み込みのギャラリーはありません）。

PUThttps://go.fliplink.me/api/set-background-image/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→背景画像の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

BackgroundIMGURL画像の URL、または https://plchldr.co/i/100x100?text=&bg=HEX のようなプレースホルダー URL

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

PUT/api/set-background-image/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-image/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG=<BackgroundIMG>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

ファビコンの設定

フリップブックのホスト型ビューアページで使われるファビコン（ブラウザのタブアイコン）を設定します。

PUThttps://go.fliplink.me/api/set-favicon/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→ファビコンの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

FaviconIMGURL—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連ロゴの設定
PUT/api/set-favicon/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-favicon/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG=<FaviconIMG>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

ページ表示の設定

ビューアのページ表示（背景、ページの影、余白などの見た目に関するオプション）を設定します。値はそのまま保存されます。古いアイテムでは、Get one で読み取ると別の値（例：regular や数値の 1）が返ることがあります。

PUThttps://go.fliplink.me/api/set-page-appearance/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→ページ表示の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

PageDepthenumflat | thin | thick次のいずれか： flat, thin, thick
CoverTypeenumsoft | hard次のいずれか： soft, hard

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リーダーナビゲーションの設定
PUT/api/set-page-appearance/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

読み込みテキストの設定

ビューアの読み込み画面に表示されるカスタムテキストを設定します。

よくある間違い: フィールドは CustomLoadingText であり、LoadingText ではありません。

PUThttps://go.fliplink.me/api/set-loading-text/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→読み込みテキストの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

CustomLoadingText—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

PUT/api/set-loading-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-loading-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText=<CustomLoadingText>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

カスタム URL の設定

フリップブックの共有 URL のカスタム（バニティ）スラッグを設定します。一意である必要があり、使用中のスラッグを指定すると Result:ERROR が返ります。

PUThttps://go.fliplink.me/api/set-custom-url/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→カスタム URL の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

CustomURL—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Custom URL already taken{ "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連共有リンクの取得CNAME の追加
PUT/api/set-custom-url/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-custom-url/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=<CustomURL>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

プレビュー PDF の設定

リード獲得や支払いの前に読者に表示するプレビュー PDF を設定します。リード獲得と販売モードの両方がオフの場合は自動的にクリアされます。

PUThttps://go.fliplink.me/api/set-preview-pdf/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→プレビュー PDF の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

PreviewPDFURL—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連画像 PDF の設定リード獲得の設定（基本）販売設定
PUT/api/set-preview-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=<PreviewPDF>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

画像 PDF の設定

サムネイルやプレビューに使う画像専用/プレビュー用の PDF を設定します。既存の画像 PDF をそのまま残すには空で送ってください。

PUThttps://go.fliplink.me/api/set-image-pdf/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→画像 PDF の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IMGPdfURL—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連プレビュー PDF の設定
PUT/api/set-image-pdf/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=<IMGPdf>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — ビューアとリーダー

ビューア操作ボタンの設定

ビューアのツールバーの各ボタン（ダウンロード、印刷、共有、全画面、ズーム、サムネイルなど）を個別に表示・非表示にします。

PUThttps://go.fliplink.me/api/set-viewer-controls/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→ビューア操作ボタンの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsShowControlstrue | false例： true
IsPrinttrue | false例： false
IsDownloadtrue | false例： false
IsThumbnailstrue | false例： true
IsSearchtrue | false例： true
IsSoundtrue | false例： true
IsFullscreentrue | false例： true
IsZoomtrue | false例： true
IsNotestrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リーダーナビゲーションの設定
PUT/api/set-viewer-controls/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リーダーナビゲーションの設定

ビューアのリーダーナビゲーション（ページのサムネイル、目次、読者のページ間の移動方法）を設定します。

PUThttps://go.fliplink.me/api/set-reader-navigation/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リーダーナビゲーションの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsNavFirstLasttrue | false例： true
BookLayoutenum1=単一、2=見開き次のいずれか： 1, 2
IsRightToLefttrue | false例： false
ScrollBehaviournumberスクロールモードの数値

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連ビューア操作ボタンの設定自動ページめくりの設定ページ表示の設定
PUT/api/set-reader-navigation/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

自動ページめくりの設定

ビューアの自動ページめくりとその間隔を有効化または無効化します。

PUThttps://go.fliplink.me/api/set-auto-flip/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→自動ページめくりの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

AutoFlipInSecsnumber名前に反して単位はミリ秒です。0 = オフ、3000 = 3 秒、5000 = 5 秒など。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リーダーナビゲーションの設定
PUT/api/set-auto-flip/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

背景音楽の設定

ビューアで再生する背景音楽トラックを設定またはクリアします。利用可能なトラックは list-background-music を参照してください。

PUThttps://go.fliplink.me/api/set-background-music/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→背景音楽の一覧取得(トラックを選ぶ)→背景音楽の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

BackgroundMusicあらかじめ用意されたトラックのファイル名（/api/list-background-music から取得）
BackgroundMusicCustomURLアップロードしたカスタム音楽の URL
IsBackgroundMusicLooptrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連背景音楽の一覧取得
PUT/api/set-background-music/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-background-music/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=<BackgroundMusic>' \
  --data-urlencode 'BackgroundMusicCustom=<BackgroundMusicCustom>' \
  --data-urlencode 'IsBackgroundMusicLoop=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — CTA

プライマリ CTA の設定

ビューア内のプライマリ（主要な）行動喚起ボタンを設定します（ラベル、URL、位置、色）。

よくある間違い: フィールドは IsCTAButton、CTAButtonText、CTAButtonURL（および位置/色）であり、Text/URL/Position ではありません。

PUThttps://go.fliplink.me/api/set-cta-primary/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→プライマリ CTA の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsCTAButtontrue | false例： false
CTAButtonText—
CTAButtonColor—
CTAButtonURLURLmailto: / tel: のプレフィックスはサーバー側で自動的に正規化されます
CTAButtonTextColor—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連セカンダリ CTA の設定CTA 表示ルールの設定
PUT/api/set-cta-primary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=<CTAButtonText>' \
  --data-urlencode 'CTAButtonColor=<CTAButtonColor>' \
  --data-urlencode 'CTAButtonURL=<CTAButtonURL>' \
  --data-urlencode 'CTAButtonTextColor=<CTAButtonTextColor>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セカンダリ CTA の設定

ビューア内のセカンダリ（補助的な）行動喚起ボタンを設定します。

よくある間違い: セカンダリボタンは 2 を付けたフィールド（IsCTAButton2、CTAButtonText2、CTAButtonURL2）を使います。

PUThttps://go.fliplink.me/api/set-cta-secondary/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→セカンダリ CTA の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsCTAButton2true | false例： false
CTAButtonText2—
CTAButtonColor2—
CTAButtonTextColor2—
CTAButtonURL2URL—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連プライマリ CTA の設定CTA 表示ルールの設定
PUT/api/set-cta-secondary/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=<CTAButtonText2>' \
  --data-urlencode 'CTAButtonColor2=<CTAButtonColor2>' \
  --data-urlencode 'CTAButtonTextColor2=<CTAButtonTextColor2>' \
  --data-urlencode 'CTAButtonURL2=<CTAButtonURL2>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

CTA 表示ルールの設定

行動喚起を読者にいつ表示するかを設定します。例：N ページ後や N 秒後など（プレビューゲートのルール）。

PUThttps://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→CTA 表示ルールの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsCTAHiddenInPreviewtrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連プライマリ CTA の設定リード獲得の設定（基本）
PUT/api/set-cta-preview-rules/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — アクセス制御

パスワードアクセスの設定

フリップブックのパスワード保護をオン/オフにし、アクセス用のパスワードを設定します。

PUThttps://go.fliplink.me/api/set-password-access/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→パスワードアクセスの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsPasswordProtectedtrue | false例： false
Password—
PwdTitle—
PwdPlaceholder—
PwdButton—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連メール許可リストの設定インデックス登録の設定
PUT/api/set-password-access/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-password-access/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=<Password>' \
  --data-urlencode 'PwdTitle=<PwdTitle>' \
  --data-urlencode 'PwdPlaceholder=<PwdPlaceholder>' \
  --data-urlencode 'PwdButton=<PwdButton>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

インデックス登録の設定

ホスト型フリップブックの検索エンジンへのインデックス登録を制御します。IsNoIndex=true にすると robots の noindex が追加され、ページがインデックスされなくなります。

PUThttps://go.fliplink.me/api/set-indexing/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→インデックス登録の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsNoIndextrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

PUT/api/set-indexing/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-indexing/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNoIndex=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

メール許可リストの設定

ビューアへのアクセスを、許可したメールアドレスのリストに制限します（ゲート付き閲覧）。

PUThttps://go.fliplink.me/api/set-email-allow-list/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→メール許可リストの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

EmailsAllowed許可するメールアドレスの区切り付きリスト

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連パスワードアクセスの設定リード認証の設定
PUT/api/set-email-allow-list/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-allow-list/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailsAllowed=<EmailsAllowed>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — リード獲得

リード獲得の設定（基本）

基本のリード獲得フォーム（読者が閲覧する前に詳細を収集するゲート）を有効化して設定します。

よくある間違い: 有効化フラグは IsLeadCapture であり、IsEnabled ではありません。

PUThttps://go.fliplink.me/api/set-lead-capture/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsLeadCapturetrue | false例： false
LeadCaptureTitle—
IsLeadAllowSkiptrue | false例： false
LeadSkipText—
LeadFormAfterPagesnumber例： 0
LeadAfterPagesnumber例： 0

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードフィールドの設定リードのカスタムフィールドの設定リードラベルの設定リードのプライバシー設定リード認証の設定リード Webhook の設定リードの Google スプレッドシート連携リードの一覧取得
PUT/api/set-lead-capture/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=false' \
  --data-urlencode 'LeadCaptureTitle=<LeadCaptureTitle>' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=<LeadSkipText>' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リードフィールドの設定

各標準リード獲得フィールド（名前、メール、電話、会社など）と、それを必須にするかどうかを切り替えます。

PUThttps://go.fliplink.me/api/set-lead-fields/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リードフィールドの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsLeadEmailtrue | false例： true
IsLeadEmailMandatorytrue | false例： true
IsLeadNametrue | false例： true
IsLeadNameMandatorytrue | false例： false
IsLeadPhonetrue | false例： false
IsLeadPhoneMandatorytrue | false例： false
IsLeadCompanytrue | false例： false
IsLeadCompanyMandatorytrue | false例： false
IsLeadDatetrue | false例： false
IsLeadDateMandatorytrue | false例： false
LeadPhoneCountry—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リード獲得の設定（基本）リードのカスタムフィールドの設定リードラベルの設定
PUT/api/set-lead-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry=<LeadPhoneCountry>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リードのカスタムフィールドの設定

標準の名前/メール/電話に加えて、リード獲得フォームに追加のカスタムフィールドを定義します。

PUThttps://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リードのカスタムフィールドの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsLeadCustom1true | false例： false
IsLeadCustom1Mandatorytrue | false例： false
Custom1Label—
IsLeadCustom2true | false例： false
IsLeadCustom2Mandatorytrue | false例： false
Custom2Label—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードフィールドの設定リードラベルの設定
PUT/api/set-lead-custom-fields/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=<Custom1Label>' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label=<Custom2Label>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リードラベルの設定

リード獲得フォームの各フィールドの表示ラベルとプレースホルダーテキストを設定します。

PUThttps://go.fliplink.me/api/set-lead-labels/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リードラベルの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

LeadEmailemail—
LeadName—
LeadPhonephone—
LeadCompany—
LeadDate—
LeadButton—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リードフィールドの設定リードのカスタムフィールドの設定
PUT/api/set-lead-labels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=<LeadEmail>' \
  --data-urlencode 'LeadName=<LeadName>' \
  --data-urlencode 'LeadPhone=<LeadPhone>' \
  --data-urlencode 'LeadCompany=<LeadCompany>' \
  --data-urlencode 'LeadDate=<LeadDate>' \
  --data-urlencode 'LeadButton=<LeadButton>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リードのプライバシー設定

リード獲得のプライバシー/同意の文面とオプション（例：GDPR の同意チェックボックス）を設定します。

PUThttps://go.fliplink.me/api/set-lead-privacy/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リードのプライバシー設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsLeadPrivacyPolicytrue | false例： false
PrivacyPolicyURLURL—
PrivacyPolicyText—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リード獲得の設定（基本）
PUT/api/set-lead-privacy/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=<PrivacyPolicyURL>' \
  --data-urlencode 'PrivacyPolicyText=<PrivacyPolicyText>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リード認証の設定

リードのメール認証をオン/オフにします。オンにすると、読者はアクセスの前にメールを確認する必要があります。

PUThttps://go.fliplink.me/api/set-lead-verification/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リード認証の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsVerifyEmailtrue | false例： false
IsVerifyMobiletrue | false例： false
TwillioAPIKeyTwilio の API キー（フィールド名は元の 'Twillio' というつづりのままです）。
EmailVerifyTitleText—
EmailVerifyButtonText—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リード獲得の設定（基本）
PUT/api/set-lead-verification/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=<TwillioAPIKey>' \
  --data-urlencode 'EmailVerifyTitleText=<EmailVerifyTitleText>' \
  --data-urlencode 'EmailVerifyButtonText=<EmailVerifyButtonText>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

リード Webhook の設定

新しいリードごとに通知を受け取る Webhook URL を設定します（新規リード用 Webhook として保存されます）。動作確認には test-webhook を使ってください。

PUThttps://go.fliplink.me/api/set-lead-webhook/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リード Webhook の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

WebhookURL_NewLeadURLあなたのエンドポイント URL。新しいリードごとに JSON ペイロードを受け取ります。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連Webhook のテストリードの一覧取得リードの Google スプレッドシート連携
PUT/api/set-lead-webhook/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=<WebhookURL_NewLead>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

Webhook のテスト

フリップブックに設定されたリード Webhook にテスト用のペイロードを送り、実際のリードなしで配信形式を確認できます。設定されていない場合は ERROR 'No lead webhook is configured for this flipbook.' を返します。ペイロードの形式は実際のリードと同じ（キー：pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2）ですが、ダミーの値（pdf_id:"-1", pdf_name:"Test PDF", ...）が入ります。実際のリードは保存されず、通知メールも送信されません。

POSThttps://go.fliplink.me/api/test-webhook/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード Webhook の設定(先に Webhook を設定する必要があります)→Webhook のテスト

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リード Webhook の設定
POST/api/test-webhook/{flipbookId}
curl -X POST 'https://go.fliplink.me/api/test-webhook/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

リードの Google スプレッドシート連携

リード獲得を Google スプレッドシートに連携します。新しいリードは、指定したシート（シート ID + 名前）に追記されます。

PUThttps://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→リード獲得の設定（基本）(リード獲得をオンにする)→リードの Google スプレッドシート連携

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

GoogleSheetURLURL—
GoogleSheetIDKey—
GoogleSheetName—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連リード Webhook の設定リードの一覧取得
PUT/api/set-lead-google-sheets/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=<GoogleSheetURL>' \
  --data-urlencode 'GoogleSheetIDKey=<GoogleSheetIDKey>' \
  --data-urlencode 'GoogleSheetName=<GoogleSheetName>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — 通知とメールテンプレート

通知の設定

このフリップブックについて受け取るメール通知（新規リード、新規閲覧、新規販売）を設定します。

PUThttps://go.fliplink.me/api/set-notifications/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→通知の設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

NotificationsEmailemail—
IsSendEmailOnViewtrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連メールテンプレートの設定 — 新規リードメールテンプレートの設定 — 新規閲覧メールテンプレートの設定 — 新規販売
PUT/api/set-notifications/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-notifications/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=<NotificationsEmail>' \
  --data-urlencode 'IsSendEmailOnView=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

メールテンプレートの設定 — 新規リード

新規リードのイベントで送るメールを設定します。デフォルトの NEW_LEAD テンプレートに戻すには空の値を送ってください。

PUThttps://go.fliplink.me/api/set-email-template-lead/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→メールテンプレートの設定 — 新規リード

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

EmailLeadSubject—
EmailLeadBody—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連通知の設定リード獲得の設定（基本）
PUT/api/set-email-template-lead/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=<EmailLeadSubject>' \
  --data-urlencode 'EmailLeadBody=<EmailLeadBody>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

メールテンプレートの設定 — 新規閲覧

新規閲覧の通知で送るメールテンプレートを設定します。デフォルトの NEW_VIEW テンプレートに戻すには空で送ってください。

PUThttps://go.fliplink.me/api/set-email-template-view/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→メールテンプレートの設定 — 新規閲覧

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

EmailViewSubject—
EmailViewBody—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連通知の設定
PUT/api/set-email-template-view/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=<EmailViewSubject>' \
  --data-urlencode 'EmailViewBody=<EmailViewBody>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

メールテンプレートの設定 — 新規販売

新規販売の通知で送るメールテンプレートを設定します。デフォルトの NEW_SALE テンプレートに戻すには空で送ってください。

PUThttps://go.fliplink.me/api/set-email-template-sale/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→メールテンプレートの設定 — 新規販売

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

EmailSaleSubject—
EmailSaleBody—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連通知の設定販売設定
PUT/api/set-email-template-sale/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=<EmailSaleSubject>' \
  --data-urlencode 'EmailSaleBody=<EmailSaleBody>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — 販売

販売設定

フリップブックの販売（価格、通貨、各種オプション）を設定します。販売モードを有効にすると、メール認証が自動的に有効になり、リードのメールが必須になります。

PUThttps://go.fliplink.me/api/set-sale-settings/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→通貨の一覧取得(SaleCurr を選ぶ)→販売設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsForSaletrue | false例： false
SaleCurr/api/list-currencies から取得
SaleAmountnumber例： 0

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連通貨の一覧取得販売ページテキストの設定販売ゲートウェイの設定フリップブック購入の登録
PUT/api/set-sale-settings/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-settings/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsForSale=false' \
  --data-urlencode 'SaleCurr=USD' \
  --data-urlencode 'SaleAmount=0'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

販売ページテキストの設定

フリップブックの販売/チェックアウトページに表示するマーケティング用の文面を設定します。

PUThttps://go.fliplink.me/api/set-sale-page-text/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→販売設定(販売を有効にする)→販売ページテキストの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

SalePageTitle—
SaleAccessPageTitle—
SalePurchaseButtonText—
SaleButtonText—
SaleAccessButtonText—
SaleButtonColor—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連販売設定販売ゲートウェイの設定
PUT/api/set-sale-page-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-page-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SalePageTitle=<SalePageTitle>' \
  --data-urlencode 'SaleAccessPageTitle=<SaleAccessPageTitle>' \
  --data-urlencode 'SalePurchaseButtonText=<SalePurchaseButtonText>' \
  --data-urlencode 'SaleButtonText=<SaleButtonText>' \
  --data-urlencode 'SaleAccessButtonText=<SaleAccessButtonText>' \
  --data-urlencode 'SaleButtonColor=<SaleButtonColor>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

販売ゲートウェイの設定

このフリップブックを販売する際に使う決済ゲートウェイを選択して設定します。

PUThttps://go.fliplink.me/api/set-sale-gateway/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→販売設定(販売を有効にする)→販売ゲートウェイの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

SaleGatewayName—
SaleGatewayKey—
SaleGatewaySecret—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連販売設定フリップブック購入の登録
PUT/api/set-sale-gateway/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-sale-gateway/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SaleGatewayName=<SaleGatewayName>' \
  --data-urlencode 'SaleGatewayKey=<SaleGatewayKey>' \
  --data-urlencode 'SaleGatewaySecret=<SaleGatewaySecret>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — 承認

承認ボタンの設定

ビューアに承認リクエストボタンを追加します。有効にすると承認リクエストのワークフローが起動します。

PUThttps://go.fliplink.me/api/set-approval-button/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(DocType=document — Document アイテムのみ)→承認ボタンの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsApprovalButtontrue | false例： false
ApprovalButtonText—
ApprovalButtonColor—
ApprovalButtonTextColor—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連承認メールテンプレートの設定
PUT/api/set-approval-button/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-button/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=false' \
  --data-urlencode 'ApprovalButtonText=<ApprovalButtonText>' \
  --data-urlencode 'ApprovalButtonColor=<ApprovalButtonColor>' \
  --data-urlencode 'ApprovalButtonTextColor=<ApprovalButtonTextColor>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

承認メールテンプレートの設定

承認ワークフローで使うメールテンプレートを設定します。空の値の場合はデフォルトが使われます。

PUThttps://go.fliplink.me/api/set-approval-email-templates/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(DocType=document — Document アイテムのみ)→承認メールテンプレートの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

EmailApproveRequestSubject—
EmailApproveRequestBody—
EmailApproveRemindSubject—
EmailApproveRemindBody—
EmailApproveSubmitSubject—
EmailApproveSubmitBody—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連承認ボタンの設定
PUT/api/set-approval-email-templates/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=<EmailApproveRequestSubject>' \
  --data-urlencode 'EmailApproveRequestBody=<EmailApproveRequestBody>' \
  --data-urlencode 'EmailApproveRemindSubject=<EmailApproveRemindSubject>' \
  --data-urlencode 'EmailApproveRemindBody=<EmailApproveRemindBody>' \
  --data-urlencode 'EmailApproveSubmitSubject=<EmailApproveSubmitSubject>' \
  --data-urlencode 'EmailApproveSubmitBody=<EmailApproveSubmitBody>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — 共有

共有マスターの設定

ビューアの共有ボタン全体のオン/オフを切り替えるマスタースイッチです。

PUThttps://go.fliplink.me/api/set-share-master/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→共有マスターの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsShareButtonstrue | false例： false

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連共有チャンネルの設定
PUT/api/set-share-master/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-master/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

共有チャンネルの設定

ビューアの共有メニューで、各 SNS の共有チャンネル（Facebook、X、LinkedIn、WhatsApp、メールなど）を個別に切り替えます。

PUThttps://go.fliplink.me/api/set-share-channels/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→共有チャンネルの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsShareFacebooktrue | false例： true
IsShareTwittertrue | false例： true
IsShareWhatsApptrue | false例： true
IsShareTelegramtrue | false例： false
IsShareLinkedIntrue | false例： true
IsSharePinteresttrue | false例： false
IsShareReddittrue | false例： false
IsShareTumblrtrue | false例： false
IsShareMessengertrue | false例： false
IsShareEmailtrue | false例： true
IsShareLinetrue | false例： false
IsShareWeChattrue | false例： false
IsShareInstagramtrue | false例： false
IsShareFlipboardtrue | false例： false
IsShareGeneraltrue | false例： true

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連共有マスターの設定
PUT/api/set-share-channels/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-share-channels/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

セクション — トラッキングと AI

アナリティクストラッキングの設定

ホスト型フリップブックに、自分のアナリティクストラッキング ID（例：Google Analytics、GTM、Facebook ピクセル）を追加します。

PUThttps://go.fliplink.me/api/set-analytics-tracking/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→アナリティクストラッキングの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

FacebookAnalyticsCode—
GoogleAnalyticsCode—
GoogleTagManager—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

PUT/api/set-analytics-tracking/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=<FacebookAnalyticsCode>' \
  --data-urlencode 'GoogleAnalyticsCode=<GoogleAnalyticsCode>' \
  --data-urlencode 'GoogleTagManager=<GoogleTagManager>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

AI プロバイダーの設定

AI 機能で使う AI プロバイダー（プロバイダー名とその API キー）を設定します。

PUThttps://go.fliplink.me/api/set-ai-provider/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→AI プロバイダーの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

AIProvider—
AIKey—

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連バーチャルアシスタントの設定
PUT/api/set-ai-provider/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=<AIProvider>' \
  --data-urlencode 'AIKey=<AIKey>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

バーチャルアシスタントの設定

ビューア内のバーチャルアシスタント（チャット/ヘルプ）の基本設定を行います。

PUThttps://go.fliplink.me/api/set-virtual-assistant/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→バーチャルアシスタントの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

IsVAtrue | false例： false
VAButtonText—
VAButtonColor—
VAButtonTextColor—
VATextアシスタントのプロンプト／指示
VAEmbeddings埋め込みデータ（文字列）

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連バーチャルアシスタントのステータステキストの設定AI プロバイダーの設定
PUT/api/set-virtual-assistant/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=<VAButtonText>' \
  --data-urlencode 'VAButtonColor=<VAButtonColor>' \
  --data-urlencode 'VAButtonTextColor=<VAButtonTextColor>' \
  --data-urlencode 'VAText=<VAText>' \
  --data-urlencode 'VAEmbeddings=<VAEmbeddings>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

バーチャルアシスタントのステータステキストの設定

ビューア内のバーチャルアシスタントが表示するステータス/あいさつのテキストを設定します。

PUThttps://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}
前提条件アカウント情報の取得(有効な API キー)→ファイルから作成(flipbookId を取得する)→バーチャルアシスタントのステータステキストの設定

パスパラメータ

flipbookIdnumberフリップブック/ドキュメントの数値 ID。create-by-file / create-by-url（ID として）または list から取得できます。

ボディパラメータ

VAButtonStatus1待機中のステータスラベル
VAButtonStatus2録音中のステータスラベル
VAButtonStatus3処理中のステータスラベル
VAButtonStatus4発話中のステータスラベル

エラーレスポンス

401Missing or invalid API keyReturns a 401 Unauthorized HTML page — there is no JSON body.
200Item ID not found or not owned by your key{ "Result": "ERROR", "Message": "Item not found" }
200Unknown or misspelled body field{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

キーが欠けている、または無効な場合は HTTP 401（HTML ページ、JSON なし）で拒否されます。それ以外のエラーはすべて HTTP 200 と { "Result": "ERROR", "Message": … } で返るため、HTTP ステータスだけでなく必ず Result で分岐してください。

関連バーチャルアシスタントの設定
PUT/api/set-virtual-assistant-status-text/{flipbookId}
curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/{flipbookId}' \  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=<VAButtonStatus1>' \
  --data-urlencode 'VAButtonStatus2=<VAButtonStatus2>' \
  --data-urlencode 'VAButtonStatus3=<VAButtonStatus3>' \
  --data-urlencode 'VAButtonStatus4=<VAButtonStatus4>'
レスポンス例200 OK
{
  "Result": "OK",
  "Message": "Updated successfully"
}

上部の 「あなたの API キー」に API キーを貼り付けてから、下のフィールドを入力して送信してください。

パスパラメータ — アイテムを特定するために必要です

ボディパラメータ

開発を続ける

API アクセスの概要API でできることと、誰に向いているか。自動化と連携FlipLink を Zapier、Make、Webhook、Google Sheets とつなげます。料金API はすべてのライフタイムプランに含まれます。$39 から。API 連携ガイドAPI で開発を進めるためのステップバイステップの解説。