# Справочники CRM и настройки стадий

Читайте типы средств связи, поставщиков дел и исходы стадий, заменяйте стадии собственной воронки и переключайте режим работы CRM.

Битрикс24 API: `crm.dictionary.*`, `crm.<E>.category.stage.replace`, `crm.lead.enable`, `crm.lead.disable`
Скоуп: `crm`

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

## Операции

- [Список записей справочника](/docs/entities/crm-v3-dictionaries/list) — `GET /v1/crm-dictionaries/:dictionary`
- [Получить запись справочника CRM](/docs/entities/crm-v3-dictionaries/get) — `GET /v1/crm-dictionaries/:dictionary/:id`
- [Заменить стадии воронки](/docs/entities/crm-v3-dictionaries/stages-replace) — `PUT /v1/deal-categories/:categoryId/stages`
- [Включить лиды](/docs/entities/crm-v3-dictionaries/leads-enable) — `POST /v1/leads/enable`
- [Выключить лиды](/docs/entities/crm-v3-dictionaries/leads-disable) — `POST /v1/leads/disable`

Справочник `:dictionary` выбирается из таблицы. Замена стадий смарт-процесса использует `/v1/categories/:entityTypeId/:categoryId/stages`. Значения списочных пользовательских полей находятся в [отдельном разделе](/docs/entities/crm-field-enum).

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

| Поле | Описание |
|---|---|
| `id` | Строковый ID из [списка справочника](/docs/entities/crm-v3-dictionaries/list) |
| `name` | Название записи, у типов средств связи может быть `null` |
| `nameShort` | Краткое название типа средства связи, может быть `null` |
| `categoryId` | ID из [воронок сделок](/docs/entities/deal-categories/list) или [воронок смарт-процесса](/docs/entities/categories/list) |
| `stageId` | ID стадии, возвращённый [заменой стадий](/docs/entities/crm-v3-dictionaries/stages-replace) или [справочником стадий](/docs/entities/statuses/list) |
| `enabled` | Включены ли лиды для всего портала |

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

| `:dictionary` | Содержимое |
|---|---|
| `activity-providers` | Поставщики дел CRM, их типы и возможности |
| `email-types` | Типы адресов электронной почты |
| `phone-types` | Типы телефонов |
| `im-types` | Типы средств обмена сообщениями |
| `web-types` | Типы сайтов |
| `stage-semantics` | Исходы стадий CRM |

1. Справочники разрешено читать ключам `READONLY`. Изменения требуют `READWRITE` и прав сотрудника в Битрикс24.
2. Включение и выключение лидов переключает **весь портал** между классическим и простым режимом CRM. Нужны права администратора CRM. Текущий режим доступен через [настройки CRM](/docs/entities/crm-settings).
3. Замена стадий меняет набор стадий одной воронки. Системные и финальные стадии сохраняются. Изменять их или удалять стадию с элементами нельзя. Элементы на другие стадии не переносятся.
4. После неопределённого сбоя записи сначала прочитайте текущее состояние. Не повторяйте изменение вслепую.

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

1. [Прочитайте справочник](/docs/entities/crm-v3-dictionaries/list).
2. Для настройки воронки получите её ID из [списка воронок](/docs/entities/deal-categories/list).
3. [Замените стадии](/docs/entities/crm-v3-dictionaries/stages-replace), сохраняя ID стадий, которые должны остаться.

## Лимиты

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

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

- [Значения списочных полей CRM](/docs/entities/crm-field-enum)
- [Настройки CRM](/docs/entities/crm-settings)
- [Ключи и авторизация](/docs/keys-auth)