Для 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 Код Описание
400 READONLY_FIELD Передано поле, задаваемое только при создании, — countryId или entityTypeId. В схеме GET /v1/requisite-presets/fields они помечены флагом createOnly
404 ENTITY_NOT_FOUND Шаблон с таким ID не найден
422 BITRIX_ERROR Битрикс24 отклонил значение одного из полей
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

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

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