通知とメールテンプレート

できること

これらのエンドポイントで、1つのフリップブックのメール周りを制御できます。どのイベントで通知するか、そしてそれらのメールに何を書くかです。これらを使ってできることは次のとおりです。

• フリップブックに対してどの通知を受け取るかを設定する（新規リード、新規閲覧、新規販売）。
• 新規リードのメールをカスタマイズする — 新規リードのイベントで送られる件名と本文。
• 新規閲覧のメールをカスタマイズする — 新規閲覧の通知で送られる件名と本文。
• 新規販売のメールをカスタマイズする — 新規販売の通知で送られる件名と本文。
• 空の値を送って、任意のテンプレートをデフォルトに戻す。

始める前に

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• {flipbookId} — フリップブック／ドキュメントの数値IDです。create-by-file／create-by-url（IDとして）や一覧から返されます。ここでの各エンドポイントは、これをパスパラメーターとして取ります。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。

各リクエストボディはform-urlencoded（JSONではありません）です。フィールドは--data-urlencodeで送ってください。

通知を設定する

PUT /api/set-notifications/{flipbookId}を使って、このフリップブックに対してどのメール通知を受け取るか（新規リード、新規閲覧、新規販売）を設定します。

ボディフィールド（form-urlencoded）:

• NotificationsEmail — 通知メールの送信先アドレスです。新しいフリップブックでは、アカウントのメールがデフォルトになります。任意のアドレスに変更でき、空で送ると解除されます。
• IsSendEmailOnView — 「閲覧された」メールを切り替えるブール値（true / false、デフォルトはfalse）です。誰かがフリップブックを閲覧したときにメールを受け取るには、trueに設定します。以下の例ではtrueを送ります。

curl -X PUT 'https://go.fliplink.me/api/set-notifications/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'NotificationsEmail=you@example.com' \
  --data-urlencode 'IsSendEmailOnView=true'

レスポンス:

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

新規リードのメールテンプレートを設定する

PUT /api/set-email-template-lead/{flipbookId}を使って、新規リードのイベントで送られるメールを設定します。空の値を送ると、デフォルトのNEW_LEADテンプレートに戻ります。

curl -X PUT 'https://go.fliplink.me/api/set-email-template-lead/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailLeadSubject=' \
  --data-urlencode 'EmailLeadBody='

レスポンス:

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

新規閲覧のメールテンプレートを設定する

PUT /api/set-email-template-view/{flipbookId}を使って、新規閲覧の通知で送られるメールテンプレートを設定します。空で送ると、デフォルトのNEW_VIEWテンプレートに戻ります。

curl -X PUT 'https://go.fliplink.me/api/set-email-template-view/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailViewSubject=' \
  --data-urlencode 'EmailViewBody='

レスポンス:

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

新規販売のメールテンプレートを設定する

PUT /api/set-email-template-sale/{flipbookId}を使って、新規販売の通知で送られるメールテンプレートを設定します。空で送ると、デフォルトのNEW_SALEテンプレートに戻ります。

curl -X PUT 'https://go.fliplink.me/api/set-email-template-sale/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailSaleSubject=' \
  --data-urlencode 'EmailSaleBody='

レスポンス:

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

起こりうるエラー

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Keyヘッダー（またはAuthorization: Bearerトークン）が存在し、正しいことを確認してください。
• アイテムIDが見つからないか、キーが所有していない場合 → HTTP 200でMessage: "Item not found"。
• 不明またはスペルミスのボディフィールド → HTTP 200でMessage: "Unknown field(s) '…'. Expected: …"。

メモ

• リード、閲覧、販売のメールテンプレートには、それぞれ組み込みのデフォルトテキストが用意されています。空の値を送ると、そのイベントのデフォルトテンプレート（それぞれNEW_LEAD、NEW_VIEW、NEW_SALE）に戻ります。
• マージトークンは##TOKEN##の形式を使います。たとえば、##FLIPLINK##は件名や本文にフリップブック名を挿入します。