Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-field-enum.md индекс документации — /llms.txt
Значения списочных полей CRM
Добавляйте, читайте, изменяйте и удаляйте отдельные варианты пользовательского поля типа «Список» без полной замены поля.
Битрикс24 API: crm.<E>.field.custom.enum.*
Скоуп: crm
Методы в процессе раскатки. Нужна возможность CRM REST v3, появившаяся после
crm 26.2200.0, и её включение администратором. Номер следующего выпуска ещё не опубликован. Недоступный метод возвращает422 METHOD_NOT_YET_AVAILABLEсerror.release.
Операции
- Создать значение —
POST /v1/userfields/:entity/enum-values - Список значений списочного поля —
GET /v1/userfields/:entity/enum-values - Получить значение списочного поля —
GET /v1/userfields/:entity/enum-values/:id - Изменить значение —
PATCH /v1/userfields/:entity/enum-values/:id - Удалить значение —
DELETE /v1/userfields/:entity/enum-values/:id
Для смарт-процессов те же операции находятся по адресу /v1/items/:entityTypeId/userfields/enum-values, для одного значения добавьте /:id. :entityTypeId=31 адресует поля счетов.
Ключевые поля
| Поле | Описание |
|---|---|
Полеid |
ОписаниеID варианта из списка значений, не ID поля |
ПолеfieldId |
ОписаниеЧисловой ID или системное имя поля из пользовательских полей CRM или полей смарт-процесса |
Полеvalue |
ОписаниеНазвание варианта |
ПолеisDefault |
ОписаниеВыбран ли вариант по умолчанию |
Полеsort |
ОписаниеПорядок отображения |
ПолеxmlId |
ОписаниеВнешний идентификатор варианта |
Что нужно знать перед работой
:entityпринимаетdeals,leads,contacts,companies,quotes,invoices. Для смарт-процесса используйте егоentityTypeIdиз списка типов.- Для списка и создания нужен
fieldId. Получение, изменение и удаление адресуют вариант по его собственному ID в рамках типа CRM. - Чтение разрешено ключам
READONLY. Изменения требуютREADWRITEи прав сотрудника в Битрикс24. xmlId: nullоставляет сохранённый внешний идентификатор. Это не команда очистки.
Типичный сценарий
- Найдите списочное поле через список полей.
- Прочитайте варианты, передав ID поля.
- Добавьте вариант, затем измените или удалите его по ID.
Лимиты
| Лимит | Значение |
|---|---|
| ЛимитСтраница списка | Значениеlimit по умолчанию 50, offset по умолчанию 0. Один запрос читает одну страницу |
| ЛимитПодсчёт | ЗначениеОбщее количество не возвращается |
| ЛимитПроверка значений | ЗначениеОграничения и права проверяет Битрикс24 |