> ## Documentation Index
> Fetch the complete documentation index at: https://docs.utage-system.com/llms.txt
> Use this file to discover all available pages before exploring further.

# LINE自動応答更新

> LINE自動応答を部分更新します。リクエストに含まれた項目のみ変更し、含まれない項目は既存値を維持します。

- `keyword_type` / `keywords` / `message` / `action_id` / `line_template_id` は `null` を指定しても既存値を維持します（取得応答の送り返し用。`keywords` はキーワード応答のまま更新する場合に限り、空配列も既存維持）
- `autoreply_group_id` は `null`・空文字で未分類に変更します
- `response_type` / `action_type` を変更する場合は、変更後に使う項目（キーワード応答へ変更なら `keywords`、動作の変更なら `message` / `action_id` / `line_template_id` のうち対応するもの）の指定が必須です
- 取得APIの応答をそのまま送り返しても内容は変わりません（更新前と同じ `action_id` / `line_template_id` は参照先が管理画面内で作成したアクション・削除済みテンプレートでも維持）。ただし管理画面で登録した5,000文字超の `message` をそのまま送り返すと422になるため、その場合は `message` を省略してください
- 新しく指定する項目の制約は作成APIと同じです

種類が `line` / `mail_line` 以外のアカウントは400を返します。


`PATCH`

```
https://api.utage-system.com/v1/accounts/{account_id}/line/autoreplies/{autoreply_id}
```


## OpenAPI

````yaml PATCH /accounts/{account_id}/line/autoreplies/{autoreply_id}
openapi: 3.0.3
info:
  title: UTAGE API
  description: >
    UTAGEのパブリックAPIです。ファネル、メール・LINE配信、会員サイト、イベント・予約、決済、メディアなどのリソースをプログラムから操作できます。


    ## 認証

    すべてのリクエストにAPIキーによるBearer認証が必要です（要素タイプ・LINEメッセージタイプ・配信条件タイプの参照エンドポイントを除く）。


    ```

    Authorization: Bearer {api_key}

    ```


    APIキーはUTAGE管理画面から発行できます。APIキーが未指定・無効・無効化済みの場合、またはアカウントが利用停止中の場合は `401
    Unauthorized`（`error.code` は `unauthorized`）が返されます。


    ## レート制限

    リクエスト数には以下の制限があります。表の値は既定値で、契約内容により異なる場合があります。


    | 分間上限 | 日間上限 |

    |----------|----------|

    | 60リクエスト/分（APIキー単位・暦の1分ごと） | 10,000リクエスト/日（アカウント単位・暦日ごと） |


    レスポンスヘッダーで分間上限の窓が終わる時刻を確認できます（分間の残数と日間の残数はヘッダーに含まれません）。


    | ヘッダー | 説明 |

    |----------|------|

    | X-RateLimit-Limit | 接続元IP単位でAPI全体に掛かる制限の上限値（APIキー単位の分間上限ではありません） |

    | X-RateLimit-Remaining | 接続元IP単位の制限の残りリクエスト数（分間上限の残数ではありません） |

    | X-RateLimit-Reset | APIキー単位の分間上限で、現在の1分間の窓が終わる（次の分が始まる）UNIXタイムスタンプ |


    上限を超えた場合は `429 Too Many Requests`（`error.code` は
    `rate_limit_exceeded`）が返されます。日間上限の超過時は `X-RateLimit-Reset`
    が翌日0:00になります（`X-RateLimit-Limit` / `X-RateLimit-Remaining`
    は超過時も接続元IP単位の値です）。認証不要のエンドポイントと読者作成（`POST
    /accounts/{account_id}/scenarios/{scenario_id}/readers`、`POST
    /accounts/{account_id}/line/friends/{friend_id}/readers`）はレート制限の対象外で、`X-RateLimit-Reset`
    ヘッダーは付きません。


    データを作成するAPIには、これとは別にAPI経由の作成件数の上限があります。超過時は `429` で `total_limit_exceeded` /
    `hourly_limit_exceeded` / `monthly_limit_exceeded`
    が返され、`details.resource_type` に対象のリソース種別が含まれます。


    ## エラーレスポンス

    エラー時は以下の形式で返されます。


    ```json

    {
      "error": {
        "code": "error_code",
        "message": "エラーメッセージ"
      }
    }

    ```


    エラーの種類によっては `error.details`
    に補足情報（バリデーションの項目別エラー、`retry_after`、`resource_type` など）が含まれます。
  version: '1.0'
  contact:
    name: UTAGE サポート
servers:
  - url: https://api.utage-system.com/v1
    description: UTAGE API
security:
  - BearerAuth: []
tags:
  - name: ファネル
    description: ファネルの作成・更新・一覧取得
  - name: ステップ
    description: ファネル内のステップの作成・更新・並び替え・一覧取得
  - name: ページ
    description: ステップ内のページの作成・更新・取得・削除・一覧取得
  - name: 配信アカウント
    description: 配信アカウントの作成・一覧取得
  - name: シナリオ
    description: シナリオの作成・一覧取得
  - name: メディア
    description: 動画・音声・通常メディアの一覧取得・アップロード・名称変更
  - name: 要素タイプ
    description: ファネルページ・レッスン・HTMLメールの要素タイプ定義、LINEメッセージタイプ・配信条件タイプの取得（認証不要）
  - name: ファネル統計
    description: ファネルの集計データ・登録者・登録経路の取得
  - name: 配信メッセージ
    description: 配信メッセージの作成・更新・テスト送信・配信統計、置き換え文字の取得
  - name: 読者
    description: 読者の作成・更新・取得、ラベル・配信履歴・開封/クリック履歴の取得
  - name: LINE
    description: LINE友だち・カスタム送信者・1対1チャット・テンプレート・テンプレートグループ・リッチメニュー・自動応答の操作
  - name: ラベル・共通読者・登録経路
    description: ラベル・共通読者・アクション・登録経路の操作
  - name: 登録経路
    description: ファネルの登録経路・登録経路グループの作成・取得・更新・削除
  - name: ファネルアクション
    description: ファネルアクション（管理画面「アクション設定」）の作成・取得・更新・削除とアクショングループの一覧取得
  - name: 登録フォーム・読者項目
    description: 読者項目と登録フォーム項目の作成・更新・取得・削除・並び替え
  - name: 連携
    description: Googleスプレッドシート連携アカウント・広告連携設定の一覧取得
  - name: 会員サイト
    description: 会員サイトの一覧取得・作成・取得・更新・削除・並び替え
  - name: コース
    description: 会員サイト配下のコースの一覧取得・作成・取得・更新・削除・並び替え
  - name: コースグループ
    description: コースグループの一覧取得・作成・取得・更新・削除
  - name: バンドル
    description: バンドル（受講生に開放するコース・コミュニティグループのセット）の一覧取得・作成・取得・更新・削除・並び替え
  - name: レッスン
    description: 会員サイトのレッスン・レッスングループの操作と、レッスンごと受講状況・受講完了者の取得
  - name: 受講生
    description: 会員サイトの受講生の作成・更新・取得・削除、受講状況・操作履歴の取得、コース・バンドルの登録受講生一覧
  - name: 登録コース・コミュニティ
    description: 受講生のバンドル・単一コース・コミュニティグループへの登録の追加・更新・解除・一覧取得
  - name: コミュニティグループ
    description: 会員サイトのコミュニティグループの一覧取得
  - name: イベント
    description: イベント（セミナー・説明会、個別相談・個別予約）の一覧取得・作成・取得・更新・削除
  - name: 日程
    description: イベントの日程の一覧取得・作成・取得・更新・削除
  - name: 日程設定
    description: 個別相談・個別予約タイプのイベントの日程設定（開催する曜日・時間帯・特定日の開催設定・担当者・日程の表示期間）の取得・更新
  - name: 申込フォーム・申込者項目
    description: イベントの申込フォームの基本項目・申込者項目の取得・更新
  - name: 申込者
    description: イベントの申込者の一覧取得・詳細取得・更新
  - name: イベントグループ
    description: イベントグループ（イベント一覧の「グループ管理」）の作成・更新・一覧取得・削除
  - name: 担当者
    description: 担当者（個別相談・個別予約の「担当者設定」）の作成・更新・一覧取得・削除と連携用リンクの発行・削除
  - name: 商品
    description: 商品の一覧取得・作成・取得・更新・削除・並び替え
  - name: 商品グループ
    description: 商品グループの一覧取得・作成・取得・更新・削除
  - name: 商品詳細
    description: 商品配下の商品詳細（価格・支払方法・決済代行会社・支払回数・購入後の動作・通知設定）の作成・更新・並び替え・取得・削除
  - name: 売上
    description: 売上の一覧・詳細取得、領収書・請求書設定の更新、銀行振込の入金反映、削除、月別・日別売上集計
paths:
  /accounts/{account_id}/line/autoreplies/{autoreply_id}:
    patch:
      tags:
        - LINE
      summary: LINE自動応答更新
      description: >
        LINE自動応答を部分更新します。リクエストに含まれた項目のみ変更し、含まれない項目は既存値を維持します。


        - `keyword_type` / `keywords` / `message` / `action_id` /
        `line_template_id` は `null` を指定しても既存値を維持します（取得応答の送り返し用。`keywords`
        はキーワード応答のまま更新する場合に限り、空配列も既存維持）

        - `autoreply_group_id` は `null`・空文字で未分類に変更します

        - `response_type` / `action_type` を変更する場合は、変更後に使う項目（キーワード応答へ変更なら
        `keywords`、動作の変更なら `message` / `action_id` / `line_template_id`
        のうち対応するもの）の指定が必須です

        - 取得APIの応答をそのまま送り返しても内容は変わりません（更新前と同じ `action_id` / `line_template_id`
        は参照先が管理画面内で作成したアクション・削除済みテンプレートでも維持）。ただし管理画面で登録した5,000文字超の `message`
        をそのまま送り返すと422になるため、その場合は `message` を省略してください

        - 新しく指定する項目の制約は作成APIと同じです


        種類が `line` / `mail_line` 以外のアカウントは400を返します。
      operationId: updateLineAutoreply
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: autoreply_id
          in: path
          required: true
          description: 自動応答ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineAutoreplyUpdateRequest'
      responses:
        '200':
          description: 更新された自動応答
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/LineAutoreply'
        '400':
          description: アカウント種類が line / mail_line 以外のため、LINE自動応答を利用できません
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: validation_error
                  message: このアカウントではLINE自動応答を利用できません
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: 配信アカウントID
      schema:
        type: string
  schemas:
    LineAutoreplyUpdateRequest:
      type: object
      description: >-
        部分更新。含まれた項目のみ変更します。`keyword_type` / `keywords` / `message` / `action_id`
        / `line_template_id` は null を指定しても既存値を維持します。
      properties:
        name:
          type: string
          maxLength: 255
          description: 管理名称
        autoreply_group_id:
          type: string
          nullable: true
          description: 自動応答グループID（null・空文字で未分類に変更）
        response_type:
          type: string
          enum:
            - keyword
            - all_messages
          description: >-
            応答タイプ。keyword: キーワード応答、all_messages: 一律応答。keyword へ変更するときは keywords
            の指定が必須
        keyword_type:
          type: string
          nullable: true
          enum:
            - part
            - all
          description: '一致。part: 部分一致、all: 完全一致（null は既存維持）'
        keywords:
          type: array
          nullable: true
          maxItems: 100
          description: >-
            キーワードの配列（null
            は既存維持。キーワード応答のまま更新する場合は空配列も既存維持。変更する場合は1〜100件・各255文字以内・改行不可・合計65,535バイト以内。"0"
            は指定不可）
          items:
            type: string
            nullable: true
            maxLength: 255
        action_type:
          type: string
          enum:
            - message
            - action
            - template
          description: >-
            動作。message: メッセージを送信、action: アクションを実行、template:
            テンプレートを送信。変更するときは変更後に使う項目の指定が必須
        message:
          type: string
          nullable: true
          maxLength: 5000
          description: 送信するメッセージ本文（null は既存維持。配信済みメッセージの置換URL・rid付きURLは不可）
        action_id:
          type: string
          nullable: true
          description: 実行するアクションID（null は既存維持。更新前と同じIDは参照先が管理画面内で作成したアクションでも維持）
        line_template_id:
          type: string
          nullable: true
          description: 送信するテンプレートID（null は既存維持。更新前と同じIDは削除済みテンプレートでも維持）
    LineAutoreply:
      type: object
      description: LINE自動応答。`response_type` / `action_type` に対応する項目のみ値が入り、対応しない項目は null です。
      properties:
        id:
          type: string
          description: 自動応答ID
        name:
          type: string
          description: 管理名称
        autoreply_group_id:
          type: string
          nullable: true
          description: 自動応答グループID（未分類は null）
        response_type:
          type: string
          enum:
            - keyword
            - all_messages
          description: >-
            応答タイプ。keyword: キーワード応答（キーワードのいずれかに一致したときのみ動作）、all_messages:
            一律応答（どのキーワード応答にも一致しなかった全てのテキストメッセージに動作）
        keyword_type:
          type: string
          nullable: true
          enum:
            - part
            - all
          description: '一致。part: 部分一致（受信メッセージにキーワードが含まれれば一致）、all: 完全一致。一律応答では null'
        keywords:
          type: array
          nullable: true
          description: キーワードの配列（いずれか1つに一致すれば実行）。一律応答では null
          items:
            type: string
        action_type:
          type: string
          enum:
            - message
            - action
            - template
          description: '動作。message: メッセージを送信、action: アクションを実行、template: テンプレートを送信'
        message:
          type: string
          nullable: true
          description: 送信するメッセージ本文（action_type=message 以外は null）
        action_id:
          type: string
          nullable: true
          description: >-
            実行するアクションID（action_type=action 以外は
            null。管理画面の自動応答編集内で直接作成したアクションを指すことがあります）
        line_template_id:
          type: string
          nullable: true
          description: 送信するテンプレートID（action_type=template 以外は null。削除済みのテンプレートを指すことがあります）
        created_at:
          type: string
          description: 作成日時
        updated_at:
          type: string
          description: 更新日時
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: エラーコード
            message:
              type: string
              description: エラーメッセージ
            details:
              type: object
              nullable: true
              description: >-
                エラーの補足情報（`retry_after` /
                `resource_type`、項目別のエラーメッセージ等）。エラー種別により含まれる場合があります。`422`
                の項目別エラーの値は通常はメッセージの配列ですが、会員サイト更新・コース更新の変更時だけ行う検証では文字列です。
  responses:
    Unauthorized:
      description: 認証エラー。APIキーが未指定・無効・無効化済み、またはアカウントが利用停止中。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: APIキーが無効です
    NotFound:
      description: 指定されたリソースが見つかりません（`error.code` は `not_found`。`message` は資源ごとに異なります）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: ページが見つかりません
    ValidationError:
      description: >-
        バリデーションエラー（`error.code` は `validation_error`）。`details`
        に項目ごとのエラーメッセージが入ります（項目に紐づかない検証では `details` なし）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: validation_error
              message: 入力内容に誤りがあります
              details:
                name:
                  - 管理用タイトルは必須です
    RateLimitExceeded:
      description: >-
        レート制限超過（`rate_limit_exceeded`）。`X-RateLimit-Reset`
        の時刻（`details.retry_after` がある場合はその日時）以降に再試行してください。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: レート制限を超過しました
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: APIキーをBearerトークンとして指定

````

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