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

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

PATCH /v1/requisite-presets/:presetId/fields/:id

Обновляет системное имя поля, заголовок, позицию сортировки или признак краткого списка у строки поля шаблона. Передавайте только те поля, которые нужно изменить.

Параметры

Параметр Тип Обяз. Описание
ПараметрpresetId (path) Типnumber Обяз.да ОписаниеID шаблона реквизита
Параметрid (path) Типnumber Обяз.да ОписаниеID строки поля шаблона (из GET /v1/requisite-presets/:presetId/fields — поле id)

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

Поле Тип Обяз. Описание
ПолеfieldName Типstring Обяз.нет ОписаниеНовое системное имя поля из списка доступных к добавлению. Если параметр отсутствует, сохраняется текущее имя при успешном чтении строки. Особенности проверки описаны ниже
ПолеfieldTitle Типstring Обяз.нет ОписаниеЗаголовок поля в интерфейсе Битрикс24
ПолеinShortList Типboolean Обяз.нет ОписаниеПоказывать ли поле в кратком списке. Принимает true/false
Полеsort Типnumber Обяз.нет ОписаниеПорядок сортировки поля в шаблоне

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/1" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldTitle": "Инн организации",
    "inShortList": false,
    "sort": 100
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sort": 100
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/1', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fieldTitle: 'Инн организации',
    inShortList: false,
    sort: 100,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/1', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    sort: 100,
  }),
})

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

Поля ответа

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

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

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

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

404 — строка поля не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Preset field 99999 not found in preset 1"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодNOT_FOUND ОписаниеСтрока поля с таким id не найдена в данном шаблоне
HTTP400 КодINVALID_FIELD_NAME ОписаниеТекущая строка успешно прочитана, а переданное fieldName отличается от её имени без учёта регистра и отсутствует в распознанном списке доступных к добавлению. Обновление не выполнено
HTTP400 КодINVALID_FIELD_NAME ОписаниеfieldName передан не строкой (числом, массивом, объектом, null). Сообщение: Field name must be a string, got <тип>.
HTTP400 КодINVALID_PRESET_ID ОписаниеpresetId не является положительным целым числом
HTTP400 КодINVALID_FIELD_ID Описаниеid не является положительным целым числом
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm. Сообщение: This endpoint requires 'crm' scope
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

Смена fieldName проверяется до записи, если доступны данные для проверки. Когда текущая строка успешно прочитана и новое имя отличается от сохранённого без учёта регистра, оно сверяется с распознанным списком доступных к добавлению. Отсутствующее в таком списке имя возвращает 400 INVALID_FIELD_NAME. Ни одно изменение запроса не записывается. Если чтение строки или списка завершилось ошибкой либо форма списка не распознана, проверка пропускается и запрос передаётся Битрикс24.

Регистр имени сохраняется по данным Битрикс24, когда они доступны. При совпадении с текущим именем используется сохранённое написание. При подтверждённом переименовании — написание из списка доступных. Если проверка пропущена, имя передаётся в написании запроса.

Успешное предварительное чтение без строки возвращает 404 NOT_FOUND до записи. Если предварительное чтение завершилось ошибкой, обновление продолжается и ответ определяется вызовом Битрикс24.

Перед обновлением перечитайте список. id строки поля позиционный и может измениться после изменения состава шаблона. Возьмите актуальный id из свежего списка полей, найдя строку по fieldName — иначе обновление затронет другое поле.

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