API

/web_api/custom_property_option/update_property

/web_api/custom_property_option/update_property ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_elements/custom_property_option/update_property.request.json

REQUEST /web_api/custom_property_option/update_property

NameTypeRequiredConstraint
custom_property_option_idintegerYesminimum 1
keyenumYes"option_key", "label", "sort_order", "is_enabled"
valueanyYes-

Other top-level fields are not allowed.

Response ​

main-app://schemas/api_elements/custom_property_option/update_property.response.json

RESPONSE /web_api/custom_property_option/update_property

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesother fields allowed
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
custom_property_option_idintegerNominimum 0
custom_property_idintegerNominimum 0
option_keystringNomaxLength 64; pattern [1][A-Z0-9_]*$
labelstringNomaxLength 120
sort_orderintegerNo-
is_enabledintegerNo-
created_atstringNo-
updated_atstringNo-

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_elements/custom_property_option/update_property.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property_option/update_property.request.json",
  "title": "REQUEST /web_api/custom_property_option/update_property",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "custom_property_option_id",
    "key",
    "value"
  ],
  "properties": {
    "custom_property_option_id": {
      "type": "integer",
      "minimum": 1
    },
    "key": {
      "type": "string",
      "enum": [
        "option_key",
        "label",
        "sort_order",
        "is_enabled"
      ]
    },
    "value": true
  }
}
Response: main-app://schemas/api_elements/custom_property_option/update_property.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property_option/update_property.response.json",
  "title": "RESPONSE /web_api/custom_property_option/update_property",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "$ref": "main-app://schemas/api_elements/custom_property_option/row.json"
        }
      }
    }
  ]
}
Fragment: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}
Fragment: main-app://schemas/api_elements/custom_property_option/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property_option/row.json",
  "title": "Row custom_property_option",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "custom_property_option_id": {
      "type": "integer",
      "minimum": 0
    },
    "custom_property_id": {
      "type": "integer",
      "minimum": 0
    },
    "option_key": {
      "type": "string",
      "maxLength": 64,
      "pattern": "^[A-Z][A-Z0-9_]*$",
      "description": "Latin letters, digits, underscore, uppercase. Unique for the team and element_type."
    },
    "label": {
      "type": "string",
      "maxLength": 120
    },
    "sort_order": {
      "type": "integer"
    },
    "is_enabled": {
      "type": "integer"
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

  1. A-Z ↩︎

Version 1.0.0 · Last updated 2026-10-07

Did this page help?