Добавить поле в шаблон

POST /v1/requisite-presets/:presetId/fields

Добавляет поле из числа доступных в шаблон реквизита. Список доступных полей возвращает GET /v1/requisite-presets/:presetId/fields/available.

Параметры

Параметр Тип Обяз. Описание
presetId (path) number да ID шаблона реквизита

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

Поле Тип Обяз. Описание
fieldName string да Идентификатор поля реквизита — например, RQ_INN. Список допустимых значений: GET /v1/requisite-presets/:presetId/fields/available
fieldTitle string нет Заголовок поля в интерфейсе Битрикс24. Если не передан, используется системное название поля
inShortList boolean нет Показывать ли поле в кратком списке. Принимает true/false
sort number нет Порядок сортировки поля в шаблоне

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldName": "RQ_CONTACT",
    "inShortList": true,
    "sort": 500
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fieldName": "RQ_CONTACT",
    "inShortList": true,
    "sort": 500
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fieldName: 'RQ_CONTACT',
    inShortList: true,
    sort: 500,
  }),
})

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/1/fields', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fieldName: 'RQ_CONTACT',
    inShortList: true,
    sort: 500,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Созданная строка поля шаблона. Полный набор полей приходит при подтверждённой сверке, иначе — только id (см. «Известные особенности»)
data.id number Идентификатор строки поля шаблона
data.fieldName string Системное имя поля реквизита: RQ_INN, RQ_COMPANY_NAME и др. Приходит при полной форме ответа
data.fieldTitle string Заголовок поля. Приходит при полной форме ответа
data.inShortList boolean Показывается ли в кратком списке. Приходит при полной форме ответа
data.sort number Порядок сортировки. Приходит при полной форме ответа

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

HTTP-статус: 201 Created

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "fieldName": "RQ_CONTACT",
    "fieldTitle": "Контактное лицо",
    "inShortList": true,
    "sort": 500
  }
}

Пример ответа — только идентификатор

Когда сверку fieldName подтвердить не удалось, приходит только идентификатор:

JSON 
{
  "success": true,
  "data": {
    "id": 1
  }
}

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

400 — неверный presetId:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PRESET_ID",
    "message": "presetId must be a positive integer"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PRESET_ID presetId не является положительным целым числом
403 SCOPE_DENIED API-ключ не имеет скоупа crm. Сообщение: This endpoint requires 'crm' scope
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Ответ приходит в одной из двух форм. После создания Вайбкод перечитывает строку и сверяет её fieldName с запрошенным. При совпадении возвращается полная строка — id, fieldName, fieldTitle, inShortList, sort. Если совпадение подтвердить не удалось, возвращается только id. Получили ответ только с id — перечитайте список полей шаблона и найдите строку по fieldName, прежде чем обновлять или удалять её.

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