# Значения списочных полей CRM

Добавляйте, читайте, изменяйте и удаляйте отдельные варианты пользовательского поля типа «Список» без полной замены поля.

Битрикс24 API: `crm.<E>.field.custom.enum.*`
Скоуп: `crm`

> **Методы в процессе раскатки.** Нужна возможность CRM REST v3, появившаяся после `crm 26.2200.0`, и её включение администратором. Номер следующего выпуска ещё не опубликован. Недоступный метод возвращает `422 METHOD_NOT_YET_AVAILABLE` с `error.release`.

## Операции

- [Создать значение](/docs/entities/crm-field-enum/create) — `POST /v1/userfields/:entity/enum-values`
- [Список значений списочного поля](/docs/entities/crm-field-enum/list) — `GET /v1/userfields/:entity/enum-values`
- [Получить значение списочного поля](/docs/entities/crm-field-enum/get) — `GET /v1/userfields/:entity/enum-values/:id`
- [Изменить значение](/docs/entities/crm-field-enum/update) — `PATCH /v1/userfields/:entity/enum-values/:id`
- [Удалить значение](/docs/entities/crm-field-enum/delete) — `DELETE /v1/userfields/:entity/enum-values/:id`

Для смарт-процессов те же операции находятся по адресу `/v1/items/:entityTypeId/userfields/enum-values`, для одного значения добавьте `/:id`. `:entityTypeId=31` адресует поля счетов.

## Ключевые поля

| Поле | Описание |
|---|---|
| `id` | ID варианта из [списка значений](/docs/entities/crm-field-enum/list), не ID поля |
| `fieldId` | Числовой ID или системное имя поля из [пользовательских полей CRM](/docs/userfields/crm/list) или [полей смарт-процесса](/docs/userfields/smart-processes/list) |
| `value` | Название варианта |
| `isDefault` | Выбран ли вариант по умолчанию |
| `sort` | Порядок отображения |
| `xmlId` | Внешний идентификатор варианта |

## Что нужно знать перед работой

1. `:entity` принимает `deals`, `leads`, `contacts`, `companies`, `quotes`, `invoices`. Для смарт-процесса используйте его `entityTypeId` из [списка типов](/docs/entities/smart-processes/list).
2. Для списка и создания нужен `fieldId`. Получение, изменение и удаление адресуют вариант по его собственному ID в рамках типа CRM.
3. Чтение разрешено ключам `READONLY`. Изменения требуют `READWRITE` и прав сотрудника в Битрикс24.
4. `xmlId: null` оставляет сохранённый внешний идентификатор. Это не команда очистки.

## Типичный сценарий

1. Найдите списочное поле через [список полей](/docs/userfields/crm/list).
2. [Прочитайте варианты](/docs/entities/crm-field-enum/list), передав ID поля.
3. [Добавьте вариант](/docs/entities/crm-field-enum/create), затем [измените](/docs/entities/crm-field-enum/update) или [удалите](/docs/entities/crm-field-enum/delete) его по ID.

## Лимиты

| Лимит | Значение |
|---|---|
| Страница списка | `limit` по умолчанию 50, `offset` по умолчанию 0. Один запрос читает одну страницу |
| Подсчёт | Общее количество не возвращается |
| Проверка значений | Ограничения и права проверяет Битрикс24 |

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

- [Справочники CRM и настройки стадий](/docs/entities/crm-v3-dictionaries)
- [Пользовательские поля](/docs/userfields)
- [Ключи и авторизация](/docs/keys-auth)