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

Создать значение списочного поля

POST /v1/userfields/:entity/enum-values

Добавляет отдельный вариант в существующее списочное пользовательское поле CRM. Тело передаётся без обёртки fields.

Возможность в процессе раскатки. Требуется обновление CRM после 26.2200.0 и включение администратором. Номер выпуска ещё не опубликован. До доступности — 422 METHOD_NOT_YET_AVAILABLE с полем error.release.

Для полей смарт-процессов используйте тот же контракт по адресу POST /v1/items/:entityTypeId/userfields/enum-values. Счета доступны также через entityTypeId=31.

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрentity (path) Типstring Обяз.да По умолч.— Описаниеdeals — сделки, leads — лиды, contacts — контакты, companies — компании, quotes — предложения, invoices — счета
ПараметрentityTypeId (path) Типinteger Обяз.для альтернативного адреса По умолч.— ОписаниеИдентификатор типа смарт-процесса или 31 для счетов

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

Поле Тип Обяз. Описание
ПолеfieldId Типinteger / string Обяз.да ОписаниеИдентификатор или код UF_* списочного поля. Источники: поля CRM, поля смарт-процесса
Полеvalue Типstring Обяз.да ОписаниеНазвание варианта
ПолеisDefault Типboolean Обяз.нет ОписаниеИспользовать по умолчанию
Полеsort Типinteger Обяз.нет ОписаниеПорядок сортировки
ПолеxmlId Типstring / null Обяз.нет ОписаниеВнешний идентификатор для интеграции

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fieldId": 6008145, "value": "VIBE-PROBE option", "isDefault": false, "sort": 500, "xmlId": "VIBE-PROBE-X"}'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fieldId": 6008145, "value": "VIBE-PROBE option", "isDefault": false, "sort": 500, "xmlId": "VIBE-PROBE-X"}'

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

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values',
  {
    "method": "POST",
    "headers": {
      "X-Api-Key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fieldId": 6008145,
      "value": "VIBE-PROBE option",
      "isDefault": false,
      "sort": 500,
      "xmlId": "VIBE-PROBE-X"
    })
  }
)
const { success, data } = await response.json()

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

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values',
  {
    "method": "POST",
    "headers": {
      "X-Api-Key": "YOUR_APP_KEY",
      "Authorization": "Bearer USER_SESSION_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fieldId": 6008145,
      "value": "VIBE-PROBE option",
      "isDefault": false,
      "sort": 500,
      "xmlId": "VIBE-PROBE-X"
    })
  }
)
const { success, data } = await response.json()

Поля ответа

HTTP 201 Created.

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеВариант поля
Полеdata.id Типinteger ОписаниеИдентификатор варианта для получения
Полеdata.fieldId Типinteger ОписаниеИдентификатор поля. См. поля CRM и поля смарт-процесса
Полеdata.value Типstring ОписаниеНазвание варианта
Полеdata.isDefault Типboolean ОписаниеИспользуется по умолчанию
Полеdata.sort Типinteger ОписаниеПорядок сортировки
Полеdata.xmlId Типstring / null ОписаниеВнешний идентификатор

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

JSON 
{
  "success": true,
  "data": {
    "id": 4119,
    "fieldId": 6008145,
    "value": "VIBE-PROBE option",
    "isDefault": false,
    "sort": 500,
    "xmlId": "VIBE-PROBE-X"
  }
}

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

400 — некорректный запрос:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Use enum fields fieldId (add only), value, isDefault, sort and xmlId with their documented types"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректная форма запроса или тип параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторённый параметр запроса
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность ещё недоступна. Сведения об обновлении — в error.release
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНекорректный ответ Битрикс24
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеНет токенов для обращения к Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеКлючу нужен скоуп crm
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеСоздание запрещено ключу READONLY

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

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

После неоднозначного сбоя сначала проверьте список вариантов. Повтор создания вслепую может добавить второй вариант.

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