метод REST scope: lists

lists.field.update

Изменить поле универсального списка

Кто может выполнять: пользователь с правом «Полный доступ» для нужного списка

Описание

Метод lists.field.update обновляет поле списка.

Тип поля изменить нельзя. Передавайте тот тип, который был задан при создании поля

Параметры

IBLOCK_TYPE_ID string обязательный

Идентификатор типа инфоблока.

Стандартные типы:
- lists — универсальные списки
- bitrix_processes — процессы
- lists_socnet — списки групп

В коробочной версии можно также указать идентификатор произвольного существующего типа инфоблоков. IBLOCK_ID или IBLOCK_CODE должен указывать на инфоблок этого типа. Доступ к операции определяется стандартными правами пользователя на инфоблок, раздел или элемент

Идентификатор можно получить с помощью метода lists.get.iblock.type.id

IBLOCK_ID integer обязательный

Идентификатор инфоблока.

Идентификатор можно получить с помощью метода lists.get

IBLOCK_CODE string обязательный

Cимвольный код инфоблока.

Код можно получить с помощью метода lists.get

Необходимо указать хотя бы один из параметров: IBLOCK_ID или IBLOCK_CODE

FIELDS array обязательный

Массив параметров.

Подробное описание

FIELD_ID string обязательный

Идентификатор поля. Для пользовательского поля имеет вид PROPERTY_PropertyId. Для системного поля является его символьным кодом.

Идентификатор можно получить с помощью метода lists.field.get

Параметр FIELDS

NAME string обязательный

Название поля

TYPE string обязательный

Тип поля. Изменить тип нельзя, передавайте тот, который был задан при создании поля.

Пользовательские поля:
- S — Строка
- N — Число
- L — Список
- F — Файл
- G — Привязка к разделам
- E — Привязка к элементам
- S:Date — Дата
- S:DateTime — Дата/Время
- S:HTML — HTML/текст
- E:EList — Привязка к элементам в виде списка
- N:Sequence — Счетчик
- S:ECrm — Привязка к элементам CRM
- S:Money — Деньги
- S:DiskFile — Файл (Диск)
- S:map_yandex — Привязка к Яндекс.Карте
- S:employee — Привязка к сотруднику

Системные поля:
- SORT — Сортировка
- ACTIVE_FROM — Начало активности
- ACTIVE_TO — Окончание активности
- PREVIEW_PICTURE — Изображение для анонса
- PREVIEW_TEXT — Текст анонса
- DETAIL_PICTURE — Детальное изображение
- DETAIL_TEXT — Детальный текст
- DATE_CREATE — Дата создания
- CREATED_BY — Кем создан
- TIMESTAMP_X — Дата изменения
- MODIFIED_BY — Кем изменен

Значения в полях Дата создания, Дата изменения, Кем создан и Кем изменен заполняются автоматически

IS_REQUIRED string необязательный

Флаг обязательности поля. Возможные значения:
- Y — да
- N — нет

MULTIPLE string необязательный

Флаг множественности поля. Возможные значения:
- Y — да
- N — нет

Системные поля и поле типа Привязка к Яндекс.Карте не могут быть множественными

SORT integer необязательный

Сортировка

DEFAULT_VALUE необязательный

Значение по умолчанию. Если включена настройка ADD_READ_ONLY_FIELD в SETTINGS, параметр становится обязательным

LIST array необязательный

Значения для поля типа Список. Массив в формате {'ID': { 'VALUE': 'Value_1', 'SORT': 10, 'DEF': 'N' }}, где 'ID' — идентификатор, VALUE — отображаемый текст, SORT — порядок сортировки, DEF — признак значения по умолчанию.

Получить идентификатор можно методом lists.field.get

LIST_TEXT_VALUES string необязательный

Альтернативный способ задания значений для поля типа Список. Строка, где значения разделены символом переноса \n

При обновлении поля типа Список можно использовать либо LIST, либо LIST_TEXT_VALUES, либо оба параметра вместе. В этом случае значения из строки добавятся к тем, что уже есть в массиве

LIST_DEF array необязательный

Значение по умолчанию для поля типа Список. Массив принимает идентификатор из LIST

CODE string необязательный

Символьный код поля. Обязателен для пользовательских полей. Для системных полей не используется

SETTINGS array необязательный

Настройки отображения и поведения.

Поддерживаются значения:
- SHOW_ADD_FORM — показывать в форме добавления
- SHOW_EDIT_FORM — показывать в форме редактирования
- ADD_READ_ONLY_FIELD — только для чтения (форма добавления)
- EDIT_READ_ONLY_FIELD — только для чтения (форма редактирования)
- SHOW_FIELD_PREVIEW — показать поле при формировании ссылки на элемент списка

Для включения настройки используйте Y, для выключения — N

USER_TYPE_SETTINGS array необязательный

Массив настроек для пользовательских полей. Структура зависит от типа поля:

  • HTML/текст — массив в формате {'height': 200}, где height — высота окна редактора
  • Привязка к элементам в виде списка — массив в формате {'size': 1, 'width': 0, 'group': 'N', 'multiple': 'N'}, где size — высота списка, width — ограничение по ширине (0 - не ограничивать), group — группировка по разделам, multiple — отображение в виде списка множественного выбора
  • Счетчик — массив в формате {'write': 'N', 'VALUE': 1}, где write — разрешение изменять значения, VALUE — текущее значение счетчика
  • Привязка к элементам CRM — массив в формате {'VISIBLE': 'N', 'LEAD': 'N', 'CONTACT': 'N', 'COMPANY': 'N', 'DEAL': 'N'}, где VISIBLE — видимость в карточке CRM, LEAD — лид, CONTACT — контакт, COMPANY — компания, DEAL — сделка
ROW_COUNT integer необязательный

Высота поля

COL_COUNT integer необязательный

Ширина поля

LINK_IBLOCK_ID integer необязательный

Идентификатор связанного списка. Обязателен для типов Привязка к разделам, Привязка к элементам и Привязка к элементам в виде списка

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":"123","FIELD_ID":"PROPERTY_1151","FIELDS":{"NAME":"Статус задачи","SORT":"50","IS_REQUIRED":"N","MULTIPLE":"N","TYPE":"L","LIST":{"1669":{"VALUE":"Планирование","SORT":10},"1671":{"VALUE":"В активной работе","SORT":20},"1673":{"VALUE":"Тестирование","SORT":30},"1675":{"VALUE":"Завершен","SORT":40},"1677":{"VALUE":"Отложен","SORT":50}},"LIST_TEXT_VALUES":"Архив","LIST_DEF":["1671"],"SETTINGS":{"SHOW_ADD_FORM":"Y","SHOW_EDIT_FORM":"Y","ADD_READ_ONLY_FIELD":"N","EDIT_READ_ONLY_FIELD":"Y","SHOW_FIELD_PREVIEW":"N"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.field.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1765371241,
        "finish": 1765371241.084551,
        "duration": 0.08455109596252441,
        "processing": 0,
        "date_start": "2025-12-09T16:54:01+03:00",
        "date_finish": "2025-12-09T16:54:01+03:00",
        "operating_reset_at": 1765371841,
        "operating": 0
    }
}

Возвращаемые данные

result boolean

Возвращает true, если поле обновлено успешно

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":"ERROR_UPDATE_FIELD",
    "error_description":"Error update the field"
}
Код Описание Значение
ERROR_REQUIRED_PARAMETERS_MISSING Required parameter X is missing Обязательный параметр не передан
ERROR_IBLOCK_NOT_FOUND Iblock not found Инфоблок не найден
ERROR_UPDATE_FIELD Error update the field Ошибка при обновлении поля
ERROR_UPDATE_FIELD The default value of the field '...' is required Включена настройка ADD_READ_ONLY_FIELD, но не указано DEFAULT_VALUE
ERROR_UPDATE_FIELD Incorrect lists specified for '...' property Ошибка в одном из параметров внутри FIELDS
ACCESS_DENIED Access denied Недостаточно прав для обновления поля

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.