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

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

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

Параметры

Параметр Тип Обяз. Описание
iblockId (path) string да Идентификатор списка — числовой IBLOCK_ID или символьный IBLOCK_CODE. Список списков: GET /v1/lists
fieldId (path) string да Идентификатор поля в форме PROPERTY_<число> или символьный код. Список полей: GET /v1/lists/:iblockId/fields

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

Поле Тип Обяз. Описание
iblockTypeId string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
fields object да Изменяемые свойства поля в форме Битрикс24 (верхний регистр)
fields.TYPE string да Текущий тип поля. Передаётся при каждом обновлении, но не меняется
fields.NAME string нет Новое название поля
fields.IS_REQUIRED string нет Обязательность заполнения: Y или N
fields.MULTIPLE string нет Множественное значение: Y или N
fields.SORT number нет Индекс сортировки поля в карточке
fields.DEFAULT_VALUE string нет Значение по умолчанию

Примеры

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"
    }
  }'

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"
    }
  }'

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',
    },
  }),
})

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',
    },
  }),
})

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.updated boolean true при успешном обновлении

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

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Required parameter \"TYPE\" is missing"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet
400 MISSING_REQUIRED_FIELDS Не передан объект fields
422 BITRIX_ERROR Битрикс24 отклонил обновление. Например, не передан TYPE — сообщение «Required parameter "TYPE" is missing»
403 BITRIX_ACCESS_DENIED Нет прав на редактирование списка
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа нет настроенных токенов
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале

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

Известные особенности

Тип поля указывается, но не меняется. Поле fields.TYPE обязательно в теле обновления — без него запрос завершается ответом 422 BITRIX_ERROR с сообщением «Required parameter "TYPE" is missing». Передавайте текущий тип поля. Сменить тип уже созданного поля через этот эндпоинт нельзя.

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