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

Шаблоны реквизитов

Шаблоны наборов полей реквизитов: «Организация», «ИП», «Физ. лицо», «Иностранное юрлицо». Шаблон определяет, какие поля доступны у реквизита, и служит источником presetId для создания реквизита через POST /v1/requisites.

Битрикс24 API: crm.requisite.preset.* Скоуп: crm

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

POST /v1/requisite-presets

Создаёт новый шаблон — шаблон набора полей реквизита. После создания шаблон становится доступен как источник presetId при POST /v1/requisites. Восстановить удалённый шаблон нельзя — создавайте новый при необходимости.

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

Поле Тип Обяз. Описание
ПолеentityTypeId Типnumber Обяз.да ОписаниеТип набора полей — всегда 8, реквизит
Полеname Типstring Обяз.да ОписаниеНазвание шаблона («Организация», «ИП», «Физ. лицо»)
ПолеcountryId Типnumber Обяз.нет ОписаниеID страны набора полей; 1 — Россия
Полеactive Типboolean Обяз.нет ОписаниеАктивен ли шаблон. По умолчанию true
Полеsort Типnumber Обяз.нет ОписаниеПорядок сортировки. По умолчанию 500
ПолеxmlId Типstring Обяз.нет ОписаниеВнешний идентификатор для синхронизации

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "name": "Организация",
    "countryId": 1,
    "active": true,
    "sort": 100
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "entityTypeId": 8,
    "name": "Организация",
    "countryId": 1
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityTypeId: 8,
    name: 'Организация',
    countryId: 1,
    active: true,
    sort: 100,
  }),
})

const { success, data } = await res.json()
console.log('Создан шаблон ID:', data.id)

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

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

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 | null Описаниеnull сразу после создания
Полеdata.createdBy Типnumber ОписаниеID создателя
Полеdata.modifyBy Типnumber | null Описаниеnull сразу после создания

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

HTTP-статус: 201 Created

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

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

422 — Битрикс24 отклонил запрос (не указано обязательное поле):

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "ENTITY_TYPE_ID is not defined or invalid."
  }
}

Ошибки

HTTP Код Описание
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил запрос — не указано обязательное поле или передано некорректное значение (текст ошибки содержит имя поля)
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

Шаблон не содержит полей после создания. Сразу после создания набор полей шаблона пустой. Чтобы добавить поля (ИНН, КПП, ФИО и т.д.), используйте POST /v1/requisite-presets/:presetId/fields. Список доступных полей для добавления — GET /v1/requisite-presets/:presetId/fields/available.

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