# UTAGE API ドキュメント

## Docs

- [はじめに](https://docs.utage-system.com/introduction.md): UTAGE APIとMCPの概要
- [認証](https://docs.utage-system.com/authentication.md): APIキーの取得方法と認証の仕組み
- [クイックスタート](https://docs.utage-system.com/quickstart.md): 5分で最初のファネルを作成する
- [変更履歴](https://docs.utage-system.com/changelog.md): UTAGE APIの変更履歴
- [基本コンセプト](https://docs.utage-system.com/guides/concepts.md): UTAGEのファネル・ステップ・ページの階層構造とページ要素の仕組み
- [LPを作成する](https://docs.utage-system.com/guides/create-lp.md): APIを使ってランディングページを作成するステップバイステップガイド
- [登録フォームを作成する](https://docs.utage-system.com/guides/create-form.md): メルマガ登録やリード獲得用のフォーム付きLPを作成する
- [エラーハンドリング](https://docs.utage-system.com/guides/error-handling.md): APIエラーの種類と対処方法
- [API概要](https://docs.utage-system.com/api-reference/overview.md): UTAGE APIの基本仕様とエンドポイント一覧
- [ファネル一覧取得](https://docs.utage-system.com/api-reference/funnel/list.md): ファネルの一覧を取得します。名前で部分一致検索が可能です。
- [ファネル作成](https://docs.utage-system.com/api-reference/funnel/create.md): 新しいファネルを作成します。
- [ファネル更新](https://docs.utage-system.com/api-reference/funnel/update.md): ファネルの情報を更新します。JS設定は全ページ共通で適用されます。
- [ステップ一覧取得](https://docs.utage-system.com/api-reference/funnel/step-list.md): 指定ファネル配下のステップ一覧を取得します。各ステップに公開URLを含みます。
- [ステップ作成](https://docs.utage-system.com/api-reference/funnel/step-create.md): 指定ファネルに新しいステップを作成します。
- [ステップ更新](https://docs.utage-system.com/api-reference/funnel/step-update.md): ステップの名前を更新します。
- [ステップ並び替え](https://docs.utage-system.com/api-reference/funnel/step-reorder.md): ステップの表示順を変更します。全ステップIDを含める必要があります。
- [ページ一覧取得](https://docs.utage-system.com/api-reference/funnel/page-list.md): 指定ステップ配下のページ一覧を取得します。各ページにcontent_type、step_url、page_urlを含みます。
- [ページ作成](https://docs.utage-system.com/api-reference/funnel/page-create.md): ステップに新しいページを作成します。
- [ページ詳細取得](https://docs.utage-system.com/api-reference/funnel/page-get.md): ページの詳細情報を取得します。要素構造（elements）またはHTML（html_source）を含みます。
- [ページ更新](https://docs.utage-system.com/api-reference/funnel/page-update.md): ページを更新します。
- [ページ削除](https://docs.utage-system.com/api-reference/funnel/page-delete.md): ページを削除します。
- [ファネル全体データ取得](https://docs.utage-system.com/api-reference/funnel/stats-get.md): **プレビュー機能。仕様は今後変更される可能性があります。** ファネルのステップ×ページ単位の集計データ（PV・UU・登録数・登録率・売上件数・購入率・売上金額）を取得します。管理画面「データ(合算)」画面と同等です。
- [ファネル日ごとデータ取得](https://docs.utage-system.com/api-reference/funnel/stats-daily.md): **プレビュー機能。仕様は今後変更される可能性があります。** ファネルの日別集計データ（PV・UU・登録数・登録率・売上件数・購入率・売上金額）を取得します。管理画面「データ(日別)」画面と同等です。
- [ファネル登録者一覧取得](https://docs.utage-system.com/api-reference/funnel/subscriber-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** ファネルの登録者（各ページのフォームから登録された人）の一覧を取得します。氏名・連絡先・登録経路・UTM・登録日時を返します。
- [ファネル登録経路一覧取得](https://docs.utage-system.com/api-reference/funnel/tracking-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** ファネルの登録経路の一覧を取得します。メッセージの配信条件で登録経路ID（tracking_id）を指定する際などに使用します。削除済みページに紐づく登録経路は除外されます。
- [ファネル登録経路別集計取得](https://docs.utage-system.com/api-reference/funnel/tracking-stats.md): **プレビュー機能。仕様は今後変更される可能性があります。** 登録経路ごとのPV・UU・登録数を取得します。管理画面「登録経路分析」画面と同等です。
- [配信アカウント一覧](https://docs.utage-system.com/api-reference/message/account-list.md): 配信アカウントの一覧を取得します。タイプや名前で絞り込みが可能です。
- [配信アカウント作成](https://docs.utage-system.com/api-reference/message/account-create.md): 新しい配信アカウントを作成します。
- [シナリオ一覧](https://docs.utage-system.com/api-reference/message/scenario-list.md): 指定アカウント配下のシナリオ一覧を取得します。
- [シナリオ作成](https://docs.utage-system.com/api-reference/message/scenario-create.md): 指定アカウントに新しいシナリオを作成します。
- [配信メッセージ一覧](https://docs.utage-system.com/api-reference/message/message-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオ配下の配信メッセージ一覧を取得します。媒体・配信タイプ・ステータスで絞り込みできます。
- [配信メッセージ作成](https://docs.utage-system.com/api-reference/message/message-create.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオに配信メッセージを新規作成します。
- [配信メッセージ詳細取得](https://docs.utage-system.com/api-reference/message/message-get.md): **プレビュー機能。仕様は今後変更される可能性があります。** 配信メッセージの詳細情報を取得します。媒体に応じた原稿全体（メール本文・LINEメッセージ・SMS本文）と URLアクションを含みます。
- [配信メッセージ更新](https://docs.utage-system.com/api-reference/message/message-update.md): **プレビュー機能。仕様は今後変更される可能性があります。** 配信メッセージを部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。
- [配信メッセージ削除](https://docs.utage-system.com/api-reference/message/message-delete.md): **プレビュー機能。仕様は今後変更される可能性があります。** 配信メッセージを論理削除します。未送信の配信予約（キュー）は削除されますが、メール原稿・配信条件・URLアクションはトーク履歴・バックナンバー保持のため削除されません。送信中（`sending`）のメッセージは削除できません。
- [配信メッセージ テスト送信](https://docs.utage-system.com/api-reference/message/message-test-send.md): **プレビュー機能。仕様は今後変更される可能性があります。** 配信メッセージのテスト送信を実行します（`channel=mail` / `line` / `sms` のみ。`channel=action` は非対応で `400`）。
- [メッセージ別配信統計](https://docs.utage-system.com/api-reference/message/message-stats-get.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定した配信メッセージの配信統計（送信数・開封数・開封率・クリック数・クリック率・解除数）を取得します。
- [シナリオ別配信統計一覧](https://docs.utage-system.com/api-reference/message/message-stats-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオ内のメッセージごとの配信統計（送信数・開封数・開封率・クリック数・クリック率・解除数）を一覧で取得します。
- [置き換え文字一覧](https://docs.utage-system.com/api-reference/message/placeholder-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオで使用できる置き換え文字（書式は `%name%`）の一覧を取得します。カテゴリで絞り込みできます。
- [全読者一覧](https://docs.utage-system.com/api-reference/message/reader/list-all.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定アカウント配下の全シナリオを横断して読者一覧を取得します。
- [シナリオ内読者一覧](https://docs.utage-system.com/api-reference/message/reader/list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオの読者一覧を取得します。
- [読者作成](https://docs.utage-system.com/api-reference/message/reader/create.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオに読者を1件登録します。オプトインを取得済みのアドレスのみ登録してください。
- [読者詳細取得](https://docs.utage-system.com/api-reference/message/reader/get.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者の詳細情報を取得します。
- [読者更新](https://docs.utage-system.com/api-reference/message/reader/update.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者を部分更新します。リクエストに含めたフィールドのみ変更し、省略したフィールドは既存値を維持します。
- [読者ラベル一覧](https://docs.utage-system.com/api-reference/message/reader/label-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者に付与されているラベル一覧を取得します。
- [読者ラベル付与](https://docs.utage-system.com/api-reference/message/reader/label-create.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者にラベルを1件付与します。既に付与済みの場合は付与済みの情報を返します。
- [読者ラベル解除](https://docs.utage-system.com/api-reference/message/reader/label-delete.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者からラベルを1件解除します。
- [読者の他シナリオ一覧](https://docs.utage-system.com/api-reference/message/reader/scenario-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 同じ読者（同一の共通読者）が登録されている他のシナリオ一覧を取得します。
- [読者の配信予約一覧](https://docs.utage-system.com/api-reference/message/reader/queue-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者の配信予約（今後送信予定のメッセージ）一覧を取得します。
- [読者の配信済一覧](https://docs.utage-system.com/api-reference/message/reader/sent-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者への配信済メッセージ一覧を取得します。
- [読者のメール開封履歴](https://docs.utage-system.com/api-reference/message/reader/open-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者のメール開封履歴を取得します。
- [読者のクリック履歴](https://docs.utage-system.com/api-reference/message/reader/click-list.md): **プレビュー機能。仕様は今後変更される可能性があります。** 読者のクリック履歴を取得します。
- [読者登録経路サマリ](https://docs.utage-system.com/api-reference/message/reader/tracking-summary.md): **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオの読者を登録経路別に集計した件数を取得します。
- [LINE友だち一覧取得](https://docs.utage-system.com/api-reference/message/line/friend-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE友だち詳細取得](https://docs.utage-system.com/api-reference/message/line/friend-get.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE友だち更新](https://docs.utage-system.com/api-reference/message/line/friend-update.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE友だちリッチメニュー切替](https://docs.utage-system.com/api-reference/message/line/friend-menu-update.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE友だちをシナリオ登録](https://docs.utage-system.com/api-reference/message/line/friend-reader-create.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE 1対1チャット送信](https://docs.utage-system.com/api-reference/message/line/chat-message-send.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINE 1対1チャット履歴取得](https://docs.utage-system.com/api-reference/message/line/chat-message-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEテンプレート一覧取得](https://docs.utage-system.com/api-reference/message/line/template-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEカスタム送信者一覧取得](https://docs.utage-system.com/api-reference/message/line/sender-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEカスタム送信者作成](https://docs.utage-system.com/api-reference/message/line/sender-create.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEカスタム送信者詳細取得](https://docs.utage-system.com/api-reference/message/line/sender-get.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEカスタム送信者更新](https://docs.utage-system.com/api-reference/message/line/sender-update.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [LINEカスタム送信者削除](https://docs.utage-system.com/api-reference/message/line/sender-delete.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [ラベル一覧](https://docs.utage-system.com/api-reference/message/label/list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [ラベル作成](https://docs.utage-system.com/api-reference/message/label/create.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [ラベル詳細取得](https://docs.utage-system.com/api-reference/message/label/get.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [ラベル更新](https://docs.utage-system.com/api-reference/message/label/update.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [ラベル削除](https://docs.utage-system.com/api-reference/message/label/delete.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者詳細取得](https://docs.utage-system.com/api-reference/message/label/common-reader-get.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者更新](https://docs.utage-system.com/api-reference/message/label/common-reader-update.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者の登録シナリオ一覧](https://docs.utage-system.com/api-reference/message/label/common-reader-scenario-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者のラベル一覧](https://docs.utage-system.com/api-reference/message/label/common-reader-label-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者へラベル付与](https://docs.utage-system.com/api-reference/message/label/common-reader-label-create.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [共通読者のラベル解除](https://docs.utage-system.com/api-reference/message/label/common-reader-label-delete.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [アクション一覧](https://docs.utage-system.com/api-reference/message/label/action-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [登録経路一覧](https://docs.utage-system.com/api-reference/message/label/tracking-list.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [登録経路分析](https://docs.utage-system.com/api-reference/message/label/tracking-stats.md): **プレビュー機能。仕様は今後変更される可能性があります。**
- [通常メディア一覧](https://docs.utage-system.com/api-reference/media/list.md): 通常メディア（画像・PDF・Office・動画・音声等）の一覧を取得します。キーワードやフォルダで絞り込みが可能です。
- [通常メディアフォルダ一覧](https://docs.utage-system.com/api-reference/media/folder-list.md): 通常メディアのフォルダ一覧を取得します。
- [通常メディア アップロードURL発行](https://docs.utage-system.com/api-reference/media/upload-url.md): 通常メディア（画像・PDF・Office・テキスト・zip等）をアップロードするためのPresigned POST情報を発行します。これは2段階アップロードの1段階目です。
- [通常メディア アップロード完了通知](https://docs.utage-system.com/api-reference/media/complete.md): `POST /media/upload-url` で取得した `presigned_post` へファイル本体をアップロードした後、このエンドポイントでアップロードを確定します。これは2段階アップロードの2段階目です。
- [動画一覧](https://docs.utage-system.com/api-reference/media/video-list.md): 動画の一覧を取得します。キーワードやフォルダで絞り込みが可能です。
- [動画フォルダ一覧](https://docs.utage-system.com/api-reference/media/video-folder-list.md): 動画フォルダの一覧を取得します。
- [動画 アップロードURL発行](https://docs.utage-system.com/api-reference/media/video-upload-url.md): ファネル・会員サイトの動画要素で再生する動画をアップロードするためのPresigned POST情報を発行します。2段階アップロードの1段階目です。
- [動画 アップロード完了通知](https://docs.utage-system.com/api-reference/media/video-complete.md): `POST /media/videos/upload-url` で取得した `presigned_post` へ動画本体をアップロードした後、このエンドポイントでアップロードを確定します。確定すると最適化（エンコード）処理が自動で起動し、`status` は `processing` で返ります。
- [音声一覧](https://docs.utage-system.com/api-reference/media/audio-list.md): 音声の一覧を取得します。キーワードやフォルダで絞り込みが可能です。
- [音声フォルダ一覧](https://docs.utage-system.com/api-reference/media/audio-folder-list.md): 音声フォルダの一覧を取得します。
- [音声 アップロードURL発行](https://docs.utage-system.com/api-reference/media/audio-upload-url.md): ファネル・会員サイトの音声要素で再生する音声をアップロードするためのPresigned POST情報を発行します。2段階アップロードの1段階目です。
- [音声 アップロード完了通知](https://docs.utage-system.com/api-reference/media/audio-complete.md): `POST /media/audios/upload-url` で取得した `presigned_post` へ音声本体をアップロードした後、このエンドポイントでアップロードを確定します。確定すると最適化（エンコード）処理が自動で起動し、`status` は `processing` で返ります。
- [要素タイプ一覧](https://docs.utage-system.com/api-reference/funnel/element-types.md): ファネルページの要素タイプ一覧を取得します（認証不要）。
- [要素プロパティ定義](https://docs.utage-system.com/api-reference/funnel/element-properties.md): 指定した要素タイプのプロパティ定義を取得します（認証不要）。
- [HTMLメール要素タイプ一覧](https://docs.utage-system.com/api-reference/reference/mail-element-types.md): HTMLメールの要素タイプ一覧を取得します（認証不要）。
- [HTMLメール要素プロパティ定義](https://docs.utage-system.com/api-reference/reference/mail-element-properties.md): 指定したHTMLメール要素タイプのプロパティ定義を取得します（認証不要）。
- [LINEメッセージタイプ定義](https://docs.utage-system.com/api-reference/reference/line-message-types.md): **プレビュー機能。仕様は今後変更される可能性があります。** LINEメッセージの作成・更新時に使用可能なメッセージタイプとパラメータ定義を取得します（認証不要）。
- [配信条件タイプ定義](https://docs.utage-system.com/api-reference/reference/message-condition-types.md): **プレビュー機能。仕様は今後変更される可能性があります。** 配信条件・読者絞り込みで使用可能な条件キー・演算子・値の型を取得します（認証不要）。
- [MCP概要](https://docs.utage-system.com/mcp/overview.md): UTAGE MCPサーバーの概要とツール一覧
- [セットアップ](https://docs.utage-system.com/mcp/setup.md): MCPサーバーへの接続方法
- [ファネルツール](https://docs.utage-system.com/mcp/tools-funnel.md): ファネル・ステップ・ページ・要素タイプの操作ツール
- [配信ツール](https://docs.utage-system.com/mcp/tools-message.md): 配信アカウント・シナリオの操作ツール
- [メディアツール](https://docs.utage-system.com/mcp/tools-media.md): メディアの一覧取得・検索・アップロードツール
- [参照ツール](https://docs.utage-system.com/mcp/tools-reference.md): HTMLメール要素・LINEメッセージタイプ・配信条件の定義を取得する参照ツール

## OpenAPI Specs

- [openapi](https://docs.utage-system.com/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.