Поля, доступные для добавления

GET /v1/requisite-presets/:presetId/fields/available

Возвращает имена полей, которые ещё можно добавить в шаблон реквизитов — те, которых пока нет в его составе. Используйте перед POST /v1/requisite-presets/:presetId/fields, чтобы узнать допустимые значения fieldName.

Параметры

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

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/available" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/available" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/available', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/available', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив имён полей, доступных для добавления
data[] string Имя поля в формате Битрикс24: стандартные поля — RQ_*, пользовательские поля — UF_CRM_*

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

JSON 
{
  "success": true,
  "data": [
    "RQ_NAME",
    "RQ_FIRST_NAME",
    "RQ_LAST_NAME",
    "RQ_SECOND_NAME",
    "RQ_CONTACT",
    "RQ_EMAIL",
    "RQ_PHONE",
    "RQ_FAX",
    "RQ_IDENT_DOC",
    "RQ_IDENT_DOC_SER",
    "RQ_IDENT_DOC_NUM",
    "RQ_IDENT_DOC_DATE",
    "RQ_IDENT_DOC_ISSUED_BY",
    "RQ_IDENT_DOC_DEP_CODE",
    "RQ_IFNS",
    "RQ_OGRNIP",
    "RQ_OKVED"
  ]
}

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

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PRESET_ID Переданный presetId не является положительным целым числом
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Список сокращается по мере наполнения шаблона. Каждое добавленное поле исчезает из ответа. Когда все доступные поля уже добавлены, data возвращает пустой массив.

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