Duplicate Search Settings for Any Fields: Overview of Methods

By default, Bitrix24 searches for duplicates using a fixed set of fields: Full Name, company name, phone, email address, and requisites. The methods crm.duplicate.volatileType.* extend this set — any standard or custom field of a lead, contact, or company can be added to the search.

The added field appears in the duplicate search settings in the Bitrix24 interface for all employees. These settings do not affect the search performed by crm.duplicate.findbycomm: that method works only with phone numbers and email addresses. Duplicate handling as a whole is described in the section Finding and Processing Duplicates in CRM.

For example, you can add a company Tax ID to the search — then Bitrix24 shows two companies with the same Tax ID as duplicates.

Quick navigation: all methods

User documentation: Searching and Handling Duplicates in Bitrix24

How to Configure Search by Additional FieldsHow to Configure Search by Additional Fields

1. Retrieve the list of available fields using the method crm.duplicate.volatileType.fields — the response contains entityTypeId and fieldCode pairs.
2. Check which fields are already connected using the method crm.duplicate.volatileType.list.
3. Connect the required field using the method crm.duplicate.volatileType.register, passing the entityTypeId and fieldCode from the first step.
4. Disconnect a field using the method crm.duplicate.volatileType.unregister, passing the record id from crm.duplicate.volatileType.list.

Identifiers and Field CodesIdentifiers and Field Codes

entityTypeId. Specifies the CRM object type. Duplicates are searched for across three objects only:

CRM Object Type	entityTypeId
Lead	1
Contact	3
Company	4

fieldCode. The symbolic code of the field: TITLE for the name, ADDRESS for the address, UF_CRM_1750854801 for a custom field. For requisite fields, the code is written with dots, for example RQ.EN.NAME. Codes are not constructed manually — take them from the response of crm.duplicate.volatileType.fields for the required entityTypeId. If you pass a code that is not in the list of available ones, crm.duplicate.volatileType.register returns the error FIELD_NOT_FOUND.

id. The identifier of the record about a connected field. It is returned by crm.duplicate.volatileType.register and crm.duplicate.volatileType.list, and it is the only value suitable for disconnecting a field.

Important ConsiderationsImportant Considerations

• No more than seven fields in total can be connected for leads, contacts, and companies. When you attempt to connect the eighth one, crm.duplicate.volatileType.register returns the error MAX_TYPES_COUNT_EXCEEDED.
• Calling crm.duplicate.volatileType.register again for a field that is already connected does not create a new record — the method returns the id of the existing one.
• After a field is connected, the duplicate index is recalculated by a background agent, so new matches do not appear in the interface right away.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the methods: Bitrix24 administrator or CRM administrator

Method	Description
crm.duplicate.volatileType.fields	Returns a list of standard and custom fields for duplicate searches
crm.duplicate.volatileType.list	Returns a list of additional fields already connected to duplicate searches
crm.duplicate.volatileType.register	Adds a field to the duplicate search settings
crm.duplicate.volatileType.unregister	Removes a field from the duplicate search settings