Обновить свойство

PATCH /v1/catalog-product-properties/:id

Изменяет существующее определение свойства. Поля передаются плоско в корне JSON. Передавайте только изменяемые поля — остальные сохраняют текущие значения. В ответ приходит перечитанное определение свойства.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор свойства

Поля запроса (body)

Поле Тип Обяз. Описание
name string нет Название свойства для отображения
code string нет Символьный код. Латинские буквы, цифры и подчёркивание, первый символ не цифра
active boolean нет Активно ли свойство
sort number нет Индекс сортировки
defaultValue string нет Значение по умолчанию
userTypeSettings object нет Настройки пользовательского типа
listType string нет Вид списка: L выпадающий, C флажки
multiple boolean нет Множественное значение
multipleCnt number нет Число полей ввода для множественного значения
rowCount number нет Число строк поля ввода
colCount number нет Число столбцов поля ввода
withDescription boolean нет Поле описания значения
searchable boolean нет Участвует в поиске
filtrable boolean нет Участвует в фильтре
isRequired boolean нет Обязательное к заполнению
linkIblockId number нет ID связанного каталога для типов привязки
fileType string нет Допустимые расширения файлов для типа F
xmlId string нет Внешний идентификатор
hint string нет Подсказка к полю

id передаётся в пути, в теле его передавать нельзя — он только для чтения. Поля iblockId, propertyType и userType задаются только при создании: PATCH с любым из них отклоняется с 400 READONLY_FIELD. Поле timestampX заполняется системой.

Примеры

curl — личный ключ

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-product-properties/659" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Рубрика товара"
  }'

curl — OAuth-приложение

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/catalog-product-properties/659" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Рубрика товара"
  }'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-properties/659', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Рубрика товара',
  }),
})

const { success, data } = await res.json()
console.log('Новое название:', data.name)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-properties/659', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Рубрика товара',
  }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Перечитанное определение свойства. Набор полей — как у `GET /v1/catalog-product-properties/:id`

Пример ответа

Показаны основные поля.

JSON 
{
  "success": true,
  "data": {
    "id": 659,
    "iblockId": 19,
    "name": "Рубрика товара",
    "propertyType": "S",
    "code": "s12",
    "active": true,
    "sort": null,
    "defaultValue": null,
    "userType": "directory",
    "userTypeSettings": {
      "group": "N",
      "multiple": "N",
      "size": 1,
      "tableName": "b_hlbd_categories",
      "width": 0
    },
    "listType": "L",
    "multiple": false,
    "multipleCnt": null,
    "rowCount": 1,
    "colCount": 30,
    "withDescription": null,
    "searchable": false,
    "filtrable": false,
    "isRequired": false,
    "linkIblockId": null,
    "fileType": null,
    "xmlId": null,
    "hint": null,
    "timestampX": "2026-03-19T18:23:02.000Z"
  }
}

Пример ответа при ошибке

422 — свойства с указанным id не существует:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "property does not exist."
  }
}

Ошибки

HTTP Код Описание
422 BITRIX_ERROR Свойства с указанным id не существует (property does not exist.)
400 READONLY_FIELD В теле передано поле только для чтения, например id
403 SCOPE_DENIED Ключу не хватает скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Смотрите также