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

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

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 Код Описание
422 BITRIX_ERROR Битрикс24 отклонил запрос — не указано обязательное поле или передано некорректное значение (текст ошибки содержит имя поля)
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

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

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