CRM dictionaries and stage settings

Read communication types, activity providers and stage outcomes, replace stages of your own funnel, and switch the CRM mode.

Bitrix24 API: crm.dictionary.*, crm.<E>.category.stage.replace, crm.lead.enable, crm.lead.disable Scope: crm

The methods are rolling out. They require the CRM REST v3 capability introduced after crm 26.2200.0, and an administrator must enable them. The next release version has not been published yet. An unavailable method returns 422 METHOD_NOT_YET_AVAILABLE with error.release.

Operations

• List dictionary entries — GET /v1/crm-dictionaries/:dictionary
• Get a dictionary entry — GET /v1/crm-dictionaries/:dictionary/:id
• Replace funnel stages — PUT /v1/deal-categories/:categoryId/stages
• Enable leads — POST /v1/leads/enable
• Disable leads — POST /v1/leads/disable

Select :dictionary from the table. Replacing Smart Process Automation stages uses /v1/categories/:entityTypeId/:categoryId/stages. Custom list field values have a separate section.

Key fields

Field	Description
Fieldid	DescriptionString ID from the dictionary list
Fieldname	DescriptionEntry name, nullable for communication types
FieldnameShort	DescriptionShort communication type name, nullable
FieldcategoryId	DescriptionID from deal funnels or Smart Process Automation funnels
FieldstageId	DescriptionStage ID returned by stage replacement or the stage dictionary
Fieldenabled	DescriptionWhether leads are enabled for the whole Bitrix24 account

Before you start

:dictionary	Contents
:dictionaryactivity-providers	ContentsCRM activity providers, their types and capabilities
:dictionaryemail-types	ContentsEmail address types
:dictionaryphone-types	ContentsPhone number types
:dictionaryim-types	ContentsMessaging service types
:dictionaryweb-types	ContentsWebsite types
:dictionarystage-semantics	ContentsCRM stage outcomes

1. READONLY keys may read dictionaries. Changes require READWRITE and the employee's Bitrix24 permissions.
2. Enabling or disabling leads switches the entire Bitrix24 account between classic and simple CRM. CRM administrator permissions are required. Read the current mode in CRM settings.
3. Stage replacement changes one funnel's stage set. System and final stages remain. They cannot be modified, and a stage containing records cannot be deleted. Records are not moved to other stages.
4. After an ambiguous write failure, read the current state first. Do not repeat the change blindly.

Typical workflow

1. Read a dictionary.
2. To configure a funnel, get its ID from the funnel list.
3. Replace stages, retaining the IDs of stages to keep.

Limits

Limit	Value
LimitDictionary read	ValueOne page, limit defaults to 50, offset to 0
LimitEntry count	ValueNo collection total is returned
LimitCRM changes	ValueBitrix24 checks permissions and restrictions

See also

• CRM list field values
• CRM settings
• Keys and authorization