Sections in the CRM Detail Form: Overview of Methods

The sections in the CRM detail form display information about the entity. For example, in a deal detail form, there may be sections about the client, order, and delivery terms.

The methods crm.item.details.configuration.* manage the sections of the detail form. You can save user-specific settings or set a uniform view for the entire company.

Quick navigation: all methods

How to Work with Form SettingsHow to Work with Form Settings

1. Define the CRM entity type using entityTypeId. You can find the identifiers in the sections System CRM Types and Smart Processes.
2. For deals and smart processes, specify the funnel in the extras parameter (dealCategoryId or categoryId). You can retrieve the list of funnels using the method crm.category.list.
3. Obtain the current configuration using the method crm.item.details.configuration.get.
4. Save changes using the method crm.item.details.configuration.set or reset the settings to default values via crm.item.details.configuration.reset.
5. To make the common configuration mandatory for all users, use crm.item.details.configuration.forceCommonScopeForAll.

Scope of SettingsScope of Settings

The scope parameter defines whose settings will be changed.

Scope Code	Purpose
P	Personal configuration for a specific user. Used by default
C	Common configuration for all Bitrix24 users

To work with personal settings, standard user permissions are sufficient. Changing common or other users' settings requires administrator rights.

Relationship with Other ObjectsRelationship with Other Objects

CRM Entity Type. The settings of the detail form apply to a specific entity type through the entityTypeId parameter. For system objects, use identifiers from the section System CRM Types, and for smart processes, refer to the section Smart Processes.

Funnels. For deals and smart processes, the view of the detail form may differ across different funnels. Specify the funnel identifier in the extras parameter. If the parameter is not provided, the system uses the default funnel.

User. Personal settings of the detail form are tied to the user through the userId parameter when scope = 'P'. If userId is not provided, the methods use the user executing the request. You can obtain the user identifier using the method user.get.

Common Causes of ErrorsCommon Causes of Errors

• An unsupported CRM entity type has been specified.
• Incorrect extras parameters have been provided for the selected type.
• Insufficient permissions to modify the common configuration.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the methods: depending on the method and parameters

Configuration ManagementConfiguration Management

Method	Description
crm.item.details.configuration.get	Returns the current settings of the detail form sections
crm.item.details.configuration.set	Saves changes to the detail form section settings
crm.item.details.configuration.reset	Resets settings to default values
crm.item.details.configuration.forceCommonScopeForAll	Makes the common configuration mandatory for all users