metafield.definition.update

Update a metafield definition's label, description, or validations (type/key are immutable).

• scope: store:admin
• storefront-visible (bumps the catalog generation): no
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^mfd_[0-9A-HJKMNP-TV-Z]{26}$"
    },
    "patch": {
      "type": "object",
      "properties": {
        "labelTR": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "descriptionTR": {
          "type": "string",
          "maxLength": 500
        },
        "validations": {
          "type": "object",
          "properties": {
            "min": {
              "type": "number"
            },
            "max": {
              "type": "number"
            },
            "maxLength": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 65536
            },
            "regex": {
              "type": "string",
              "maxLength": 200
            },
            "choices": {
              "minItems": 1,
              "maxItems": 50,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 100
              }
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "patch"
  ],
  "additionalProperties": false
}