catalog.category.update

Update a category (partial): name/handle/status + rich content (description, banner, meta title/description).

• Scope: catalog.category.write
• System: no
• Reachable from: POST /v1/commands/catalog.category.update (tenant credential) · MCP tool catalog.category.update · SDK client.call('catalog.category.update', …)
• Events: catalog.category.updated

Input (JSON Schema)

{
  "properties": {
    "banner_kind": {
      "anyOf": [
        {
          "enum": [
            "image",
            "document",
            "video_external"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "banner_provider_key": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "category_id": {
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "handle": {
      "minLength": 1,
      "type": "string"
    },
    "icon_kind": {
      "anyOf": [
        {
          "enum": [
            "image",
            "document",
            "video_external"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "icon_provider_key": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "meta_description": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "meta_title": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  },
  "required": [
    "category_id"
  ],
  "type": "object"
}

Result (200)

Open (unknown) — this command does not declare an output schema.

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)