---
updatedAt: 2026-04-27T13:23:27.000Z
agentTools:
  projectIndex: https://developers.karte.io/llms.txt
---

# Update collection

Craft Cross CMSのコレクションを更新します。

#### Required Scope
APIの実行に必要なScopeです。
```
beta.cms.collection.update
```

#### Required Role
管理画面でScopeを追加する際に必要な権限です。
```
Craft Cross CMS > CMSの編集
```


# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.karte.io",
      "description": "Production server"
    },
    {
      "url": "https://api-jp.karte.io",
      "description": "Production JP server. リージョン固定オプションのプロジェクトはこちらのエンドポイントを利用してください."
    }
  ],
  "info": {
    "version": "2.0.0",
    "title": "CMS Management"
  },
  "paths": {
    "/v2beta/cms/collection/update": {
      "post": {
        "tags": [
          "Collections"
        ],
        "summary": "Update collection",
        "description": "Craft Cross CMSのコレクションを更新します。\n\n#### Required Scope\nAPIの実行に必要なScopeです。\n```\nbeta.cms.collection.update\n```\n\n#### Required Role\n管理画面でScopeを追加する際に必要な権限です。\n```\nCraft Cross CMS > CMSの編集\n```\n",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "collectionId": {
                    "type": "string",
                    "description": "更新対象のコレクションID"
                  },
                  "data": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "minLength": 1,
                        "description": "コレクション名"
                      },
                      "description": {
                        "type": "string",
                        "description": "コレクションの説明"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "required": [
                  "collectionId",
                  "data"
                ],
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "成功レスポンス",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "コレクションのID",
                      "example": "6347f05d5d18d4536af5f336"
                    },
                    "name": {
                      "type": "string",
                      "description": "コレクション名",
                      "example": "Blog Posts"
                    },
                    "description": {
                      "type": "string",
                      "description": "コレクションの説明",
                      "example": "ブログ記事を管理するコレクション"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "description"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. CMS Management API 400 responses include a non-empty detail.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/CmsBadRequestProblemDetail"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "x-karte-api",
            "schema": {
              "type": "string"
            },
            "description": "今後利用する可能性のある予約語です。現在は設定不要です。"
          },
          {
            "in": "header",
            "name": "authorization",
            "schema": {
              "type": "string"
            },
            "description": "認証情報を含むトークンです。\"Authorization\" ヘッダーに `Bearer <token>` の形式で設定してください。"
          },
          {
            "in": "header",
            "name": "content-type",
            "schema": {
              "type": "string"
            },
            "description": "リクエストのコンテンツタイプを指定します。通常は `application/json` を使用してください。"
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "CmsBadRequestProblemDetail": {
        "description": "RFC 9457 Problem Details returned when the CMS request is invalid.",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "https://api.karte.io/errors/bad-request"
            ]
          },
          "title": {
            "type": "string",
            "enum": [
              "Bad Request"
            ]
          },
          "status": {
            "type": "integer",
            "enum": [
              400
            ]
          },
          "detail": {
            "type": "string",
            "minLength": 1
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              },
              "required": [
                "field",
                "message"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "type",
          "title",
          "status",
          "detail"
        ],
        "additionalProperties": false
      }
    }
  },
  "x-explorer-enabled": false
}
````