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

Обновить шаблон реквизитов

PATCH /v1/requisite-presets/:id

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

Параметры

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

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

Поле Тип Обяз. Описание
Полеname Типstring Обяз.нет ОписаниеНазвание шаблона
Полеactive Типboolean Обяз.нет ОписаниеАктивен ли шаблон
Полеsort Типnumber Обяз.нет ОписаниеПорядок сортировки
ПолеxmlId Типstring Обяз.нет ОписаниеВнешний идентификатор для синхронизации

Примеры

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Организация (обновлено)",
    "sort": 999
  }'

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

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Организация (обновлено)"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Организация (обновлено)',
    sort: 999,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Организация (обновлено)',
  }),
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбновлённый шаблон с актуальными значениями полей
Полеdata.id Типnumber ОписаниеИдентификатор шаблона
Полеdata.entityTypeId Типnumber ОписаниеТип набора полей — 8
Полеdata.countryId Типnumber ОписаниеID страны набора полей
Полеdata.name Типstring ОписаниеНазвание шаблона
Полеdata.active Типboolean ОписаниеАктивен ли шаблон
Полеdata.sort Типnumber ОписаниеПорядок сортировки
Полеdata.xmlId Типstring | null ОписаниеВнешний идентификатор
Полеdata.createdAt Типstring ОписаниеДата создания (ISO 8601)
Полеdata.updatedAt Типstring ОписаниеДата последнего обновления (ISO 8601)
Полеdata.createdBy Типnumber ОписаниеID создателя
Полеdata.modifyBy Типnumber | null ОписаниеID пользователя, выполнившего обновление

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

JSON 
{
  "success": true,
  "data": {
    "id": 31,
    "entityTypeId": 8,
    "countryId": 1,
    "createdAt": "2026-06-10T09:31:49.000Z",
    "updatedAt": "2026-06-10T09:31:49.000Z",
    "createdBy": 1,
    "modifyBy": null,
    "name": "Организация (обновлено)",
    "xmlId": null,
    "active": true,
    "sort": 999
  }
}

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

404 — шаблон не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Preset with ID '999999' is not found"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодREADONLY_FIELD ОписаниеПередано поле, задаваемое только при создании, — countryId или entityTypeId. В схеме GET /v1/requisite-presets/fields они помечены флагом createOnly
HTTP404 КодENTITY_NOT_FOUND ОписаниеШаблон с таким ID не найден
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил значение одного из полей
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

Поля entityTypeId и countryId задаются только при создании. В схеме GET /v1/requisite-presets/fields они приходят с флагом createOnly и с readonly: false — записать их можно, но лишь в теле создания. Передача любого из них в теле обновления отклоняется с 400 READONLY_FIELD. Чтобы использовать другую страну, создайте новый шаблон.

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