catalog.collection.update

Patch collection fields.

• scope: catalog:write
• storefront-visible (bumps the catalog generation): yes
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^col_[a-zA-Z0-9]{1,32}$"
    },
    "patch": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "handle": {
          "type": "string",
          "maxLength": 64,
          "pattern": "^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$"
        },
        "descriptionMd": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 20000
            },
            {
              "type": "null"
            }
          ]
        },
        "imageMediaId": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^med_[a-zA-Z0-9]{1,32}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "imageAlt": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "patch"
  ],
  "additionalProperties": false
}