API リファレンス

OKAERI の公開 API の全操作です。このリファレンスは機械可読の仕様（openapi.json）から作っています。共通の決まりは概要を参照してください。

AI・コーディングエージェント向けにこのページの Markdown 版とllms.txtがあります。

• サイト（6 件）
• 同意の設定（1 件）
• キャンペーン（7 件）
• シナリオ（9 件）
• 文面（10 件）
• リード（2 件）
• 配信（2 件）
• 配信スイッチ（1 件）
• 除外リスト（3 件）
• レポート（2 件）
• Webhook（6 件）
• スキーマ（リクエスト・応答・Webhook の本文の型）

読み方

• パスはベース URL（https://api.okaeri.tech）からの完全な形です
• 必要なスコープは、API キーに付いている必要がある権限です（openapi.json の x-okaeri-scopes）
• 「null 可」は null が入ることがある項目です。「必須」はリクエストで省略できない項目です
• 値の一覧が「今後増えることがある」項目は、知らない値を受けても処理が止まらないようにしてください
• 型が「object（項目は未掲載）」の応答は、項目の一覧をまだこの文書に載せていないものです

サイト

• GET /api/v1/sites　サイトの一覧（listSites）
• GET /api/v1/sites/{site_id}　サイトの取得（設置コードつき）（getSite）
• POST /api/v1/sites/{site_id}/url-rules/test　URL がどのキャンペーンに当たるかのテスト（testSiteUrlRules）
• GET /api/v1/sites/{site_id}/tag-config　タグに配る設定の取得（getSiteTagConfig）
• GET /api/v1/sites/{site_id}/pp-checks　プライバシーポリシー確認の結果の一覧（listSitePpChecks）
• GET /api/v1/sites/{site_id}/pp-checks/{check_id}　プライバシーポリシー確認の結果の取得（getSitePpCheck）

同意の設定

• GET /api/v1/consent_settings　同意の設定の取得（getConsentSettings）

キャンペーン

• GET /api/v1/campaigns　キャンペーンの一覧（listCampaigns）
• POST /api/v1/campaigns　キャンペーンの作成（createCampaign）
• GET /api/v1/campaigns/{campaign_id}　キャンペーンの取得（getCampaign）
• PATCH /api/v1/campaigns/{campaign_id}　キャンペーンの更新（updateCampaign）
• PUT /api/v1/campaigns/{campaign_id}/url-rules　キャンペーンの URL ルールの置き換え（replaceCampaignUrlRules）
• PUT /api/v1/campaigns/{campaign_id}/form-profile　キャンペーンのフォーム項目の置き換え（replaceCampaignFormProfile）
• POST /api/v1/campaigns/{campaign_id}/duplicate　キャンペーンの複製（duplicateCampaign）

シナリオ

• GET /api/v1/campaigns/{campaign_id}/scenarios　キャンペーンのシナリオの一覧（listCampaignScenarios）
• POST /api/v1/campaigns/{campaign_id}/scenarios　シナリオの作成（createCampaignScenario）
• GET /api/v1/scenarios/{scenario_id}　シナリオの取得（getScenario）
• PATCH /api/v1/scenarios/{scenario_id}　シナリオの更新（updateScenario）
• DELETE /api/v1/scenarios/{scenario_id}　シナリオの削除（deleteScenario）
• PUT /api/v1/scenarios/{scenario_id}/steps　シナリオのステップの置き換え（replaceScenarioSteps）
• GET /api/v1/scenario_presets　シナリオのテンプレートの一覧（listScenarioPresets）
• POST /api/v1/campaigns/{campaign_id}/scenarios/from_preset　テンプレートからシナリオを作成（createCampaignScenarioFromPreset）
• POST /api/v1/scenarios/{scenario_id}/duplicate　シナリオの複製（duplicateScenario）

文面

• GET /api/v1/messages　文面の一覧（listMessages）
• POST /api/v1/messages　文面の作成（createMessage）
• GET /api/v1/messages/{message_id}　文面の取得（getMessage）
• PATCH /api/v1/messages/{message_id}　文面の更新（updateMessage）
• DELETE /api/v1/messages/{message_id}　文面の削除（deleteMessage）
• POST /api/v1/messages/{message_id}/duplicate　文面の複製（duplicateMessage）
• GET /api/v1/message_variables　文面で使える変数の一覧（listMessageVariables）
• GET /api/v1/message_examples　文面の例文の一覧（listMessageExamples）
• POST /api/v1/message_previews　文面のプレビュー（previewMessage）
• POST /api/v1/messages/estimate　SMS の文字数と課金通数の見積（estimateSmsSegments）

リード

• GET /api/v1/leads　リードの一覧（listLeads）
• GET /api/v1/leads/{lead_id}　リードの取得（流入元・時系列つき）（getLead）

配信

• GET /api/v1/deliveries　配信の一覧（listDeliveries）
• GET /api/v1/deliveries/{delivery_id}　配信の取得（getDelivery）

配信スイッチ

• GET /api/v1/delivery_status　配信スイッチの状態の取得（getDeliveryStatus）

除外リスト

• GET /api/v1/suppressions　除外リストの一覧（listSuppressions）
• POST /api/v1/suppressions　除外リストへの登録（1件）（createSuppression）
• DELETE /api/v1/suppressions/{suppression_id}　除外リストからの削除（deleteSuppression）

レポート

• GET /api/v1/reports/funnel　ファネルと指標のレポート（getFunnelReport）
• GET /api/v1/reports/daily　日次推移のレポート（getDailyReport）

Webhook

• GET /api/v1/webhook_endpoints　Webhook 送信先の一覧（listWebhookEndpoints）
• POST /api/v1/webhook_endpoints　Webhook 送信先の作成（createWebhookEndpoint）
• GET /api/v1/webhook_endpoints/{endpoint_id}　Webhook 送信先の取得（getWebhookEndpoint）
• DELETE /api/v1/webhook_endpoints/{endpoint_id}　Webhook 送信先の削除（deleteWebhookEndpoint）
• GET /api/v1/webhook_endpoints/{endpoint_id}/deliveries　Webhook の送信ログの一覧（listWebhookEndpointDeliveries）
• POST /api/v1/webhook_deliveries/{delivery_id}/redeliver　Webhook の再送（redeliverWebhookDelivery）