API

/web_api/custom_property/update_property_mass

/web_api/custom_property/update_property_mass ​

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/update_property_mass.request.json

REQUEST /web_api/custom_property/update_property_mass

NameTypeRequiredConstraint
element_idsarray of integer | stringYes-
keystringYesminLength 1
valueanyNo-

Other top-level fields are allowed.

Response ​

main-app://schemas/api_elements/custom_property/update_property_mass.response.json

RESPONSE /web_api/custom_property/update_property_mass

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultintegerYesminimum 0
emptybooleanNo-

Other top-level fields are not allowed.

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/update_property_mass.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property/update_property_mass.request.json",
  "title": "REQUEST /web_api/custom_property/update_property_mass",
  "$ref": "main-app://schemas/_shared/update-property-mass.request.json"
}
Fragment: main-app://schemas/_shared/update-property-mass.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/update-property-mass.request.json",
  "type": "object",
  "required": ["element_ids", "key"],
  "additionalProperties": true,
  "properties": {
    "element_ids": {
      "type": "array",
      "items": { "type": ["integer", "string"] }
    },
    "key": { "type": "string", "minLength": 1 },
    "value": true
  }
}
Response: main-app://schemas/api_elements/custom_property/update_property_mass.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/custom_property/update_property_mass.response.json",
  "title": "RESPONSE /web_api/custom_property/update_property_mass",
  "$ref": "main-app://schemas/_shared/update-property-mass.response.json"
}
Fragment: main-app://schemas/_shared/update-property-mass.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/update-property-mass.response.json",
  "title": "Eloquent update() row count",
  "allOf": [
    { "$ref": "main-app://schemas/_shared/envelope-success.json" },
    {
      "type": "object",
      "properties": {
        "api_result": { "type": "integer", "minimum": 0 }
      }
    }
  ]
}
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
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?