Для AI-агентов: markdown этой страницы — /docs-content/lists/fields/update.md индекс документации — /llms.txt

Обновить поле

PATCH /v1/lists/:iblockId/fields/:fieldId

Изменяет свойства существующего поля списка. Новые значения передаются в объекте fields в форме Битрикс24.

Параметры

Параметр	Тип	Обяз.	Описание
`iblockId` (path)	string	да	Идентификатор или символьный код списка. Возьмите `ID` или `CODE` из ответа метода Список списков
`fieldId` (path)	string	да	Значение `FIELD_ID` из ответа метода Поля списка. У пользовательских полей — `PROPERTY_<число>`, у системных — символьный код, например `NAME`

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

Основные настройки: название fields.NAME, обязательность fields.IS_REQUIRED и порядок fields.SORT. Текущий тип fields.TYPE передаётся при каждом обновлении.

Поле	Тип	Обяз.	Описание
`iblockTypeId`	string	нет	Тип инфоблока. Значения: `lists` — обычные списки, по умолчанию `lists_socnet` — списки рабочих групп `bitrix_processes` — служебные бизнес-процессы `structure` — тип структуры компании (здесь лежит штатный инфоблок графика отсутствий `absence`)
`socnetGroupId`	number	нет	ID рабочей группы для списков типа `lists_socnet`. Положительное целое число из поля `id` метода Список рабочих групп
`fields`	object	да	Свойства поля в форме Битрикс24. Имена свойств — в верхнем регистре. Передавайте `NAME`, текущий `TYPE` и свойства, которые нужно изменить
`fields.TYPE`	string	да	Текущий тип из поля `TYPE` метода Получить поле. Передаётся при каждом обновлении, но не меняется. Расшифровка кодов — Типы полей
`fields.NAME`	string	да	Название поля. Передавайте текущее название, если его не нужно менять
`fields.IS_REQUIRED`	string	нет	Обязательность заполнения: `Y` или `N`
`fields.MULTIPLE`	string	нет	Множественное значение: `Y` или `N`
`fields.SORT`	number	нет	Порядок поля в карточке. Чтобы сохранить порядок, передайте текущее значение `SORT` из метода Получить поле. Без `SORT` поле может переместиться в начало. После обновления значения сортировки пересчитываются с шагом 10
`fields.DEFAULT_VALUE`	string или object	нет	Значение по умолчанию. Формат зависит от `TYPE`: у `S` это строка, у `S:HTML` — объект с ключами `TYPE` и `TEXT`
`fields.CODE`	string	нет	Символьный код пользовательского поля. В пути запроса используйте `FIELD_ID`, а не этот код
`fields.ROW_COUNT`	number	нет	Высота поля ввода в строках
`fields.COL_COUNT`	number	нет	Ширина поля ввода в символах
`fields.LINK_IBLOCK_ID`	number	нет	ID связанного списка для типов привязки `G`, `E`, `E:...`. Источник — поле `ID` метода Список списков
`fields.USER_TYPE_SETTINGS`	object	нет	Настройки расширенного типа свойства. Состав зависит от `TYPE`. Текущие настройки — в поле `USER_TYPE_SETTINGS` метода Получить поле
`fields.LIST`	object	нет	Варианты для поля типа `L`. Ключ — ID варианта из `DISPLAY_VALUES_FORM` метода Получить поле, значение — объект с описанными ниже свойствами
`fields.LIST.<ID>.VALUE`	string	да	Текст варианта выбора
`fields.LIST.<ID>.SORT`	number	нет	Порядок варианта выбора
`fields.LIST.<ID>.DEF`	string	нет	Выбор варианта по умолчанию: `Y` или `N`
`fields.LIST_TEXT_VALUES`	string	нет	Новые варианты для поля типа `L`, по одному в строке. Разделитель — `\n`. Можно передать вместе с `LIST`
`fields.LIST_DEF`	string[]	нет	ID вариантов по умолчанию для поля типа `L`. Источник — ключи `DISPLAY_VALUES_FORM` метода Получить поле. Передайте эти варианты также в `LIST`
`fields.SETTINGS`	object	нет	Настройки отображения поля. Чтобы сохранить остальные настройки этого объекта, передайте их вместе с изменёнными
`fields.SETTINGS.SHOW_ADD_FORM`	string	нет	Показывать поле при добавлении элемента: `Y` или `N`
`fields.SETTINGS.SHOW_EDIT_FORM`	string	нет	Показывать поле при изменении элемента: `Y` или `N`
`fields.SETTINGS.ADD_READ_ONLY_FIELD`	string	нет	Поле доступно только для чтения при добавлении элемента: `Y` или `N`. Для `Y` задайте значение по умолчанию
`fields.SETTINGS.EDIT_READ_ONLY_FIELD`	string	нет	Поле доступно только для чтения при изменении элемента: `Y` или `N`
`fields.SETTINGS.SHOW_FIELD_PREVIEW`	string	нет	Показывать поле при предварительном просмотре элемента: `Y` или `N`

Примеры

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

Terminal

curl -X PATCH https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "Текущий статус",
      "TYPE": "S",
      "SORT": 10
    }
  }'

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

Terminal

curl -X PATCH https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "Текущий статус",
      "TYPE": "S",
      "SORT": 10
    }
  }'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'Текущий статус',
      TYPE: 'S',
      SORT: 10,
    },
  }),
})

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

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/23/fields/PROPERTY_1177', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'Текущий статус',
      TYPE: 'S',
      SORT: 10,
    },
  }),
})

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	object	Результат обновления поля
`data.updated`	boolean	`true` при успешном обновлении

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

HTTP 200 OK:

JSON

{
  "success": true,
  "data": {
    "updated": true
  }
}

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

422 — не передан TYPE: