Для 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)

Поле Тип Обяз. Описание
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 Код Описание
404 NOT_FOUND Строка поля с таким id не найдена в данном шаблоне
400 INVALID_FIELD_NAME Переданное fieldName отличается от имени строки и отсутствует среди доступных к добавлению. Обновление не выполнено
400 INVALID_FIELD_NAME fieldName передан не строкой (числом, массивом, объектом, null). Сообщение: Field name must be a string, got <тип>.
400 INVALID_PRESET_ID presetId не является положительным целым числом
400 INVALID_FIELD_ID id не является положительным целым числом
403 SCOPE_DENIED API-ключ не имеет скоупа crm. Сообщение: This endpoint requires 'crm' scope
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Смена fieldName проверяется до записи. Если fieldName в теле отличается от имени, которое строка уже несёт, имя сверяется со списком доступных к добавлению; имя вне этого списка возвращает 400 INVALID_FIELD_NAME, и ни одно поле строки не меняется — в том числе sort и fieldTitle, если они пришли тем же запросом. Метод обновления в Битрикс24 сам имя не проверяет, поэтому без этой сверки в шаблоне оседало имя, за которым нет поля. Имя, которое уже занято другой строкой того же шаблона, в списке доступных отсутствует и тоже отклоняется. Надёжнее по-прежнему не переименовывать строку, а удалить её и добавить новую с нужным fieldName.

Регистр имени приводится к тому, что вернул Битрикс24. fieldName можно писать в любом регистре: если имя совпадает с текущим, в шаблон записывается сохранённое написание, а при переименовании — то, которое перечислил список доступных. Собственное написание запроса до шаблона не доезжает.

Запрос с fieldName на несуществующую строку отвечает 404 до записи. Раньше он уходил в Битрикс24 и возвращал его ответ.

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

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