Merge Duplicates crm.entity.mergeBatch

Scope: crm

Who can execute the method: administrator

The method crm.entity.mergeBatch merges multiple entities into one.

Method Parameters

Required parameters are marked with *

Name `type`	Description
params* `object`	Object containing the entities to merge (detailed description)

Parameter params

Name
type

Description

entityTypeId*
integer

Identifier of the CRM object type. Possible values:

1 — lead
2 — deal
3 — contact
4 — company
7 — estimate
31 — invoice
128 — SPA. The identifier of a specific SPA can be found using the methods crm.enum.ownertype and crm.type.list

entityIds*
integer[]

Array of identifiers of the entities to be merged. At least two entities are required

Method Operation Features

You can only merge entities of the same type: lead with lead, contact with contact, SPA element with ID 128 with another SPA element with ID 128.

Full automatic merging is available in several cases:

the entities are identical,
the entities are not identical, but the differences in field values do not require manual processing. For example, if one entity has a field filled and the other has the same field empty — the value from the filled field will be retained.

The main entity in the merge will be the one whose ID is specified first in the entityIds array. Information from other entities will be transferred to the main entity. All entities except the main one will be deleted after a successful merge.

Manual Merging in Case of Conflict

If the method returns a status of CONFLICT, you can continue the merge manually in the Bitrix24 interface via the link:

Contacts: /crm/contact/merge/?id=1,2,3
Companies: /crm/company/merge/?id=1,2,3
Leads: /crm/lead/merge/?id=1,2,3
Deals: /crm/deal/merge/?id=1,2,3

The id parameter contains the identifiers of the entities to be merged, separated by commas.

Invoices: /crm/type/31/merge/?id[]=1&id[]=2
Estimates: /crm/type/7/merge/?id[]=1&id[]=2
SPAs: /crm/type/128/merge/?id[]=1&id[]=2

The id[] parameter contains the identifiers of the entities to be merged, passed as a repeating parameter.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"params":{"entityTypeId":3,"entityIds":[100,101,102]}}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.entity.mergeBatch

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"auth":"**put_access_token_here**","params":{"entityTypeId":3,"entityIds":[100,101,102]}}' \
             https://**put_your_bitrix24_address**/rest/crm.entity.mergeBatch

try
        {
        	const response = await $b24.callMethod(
        		'crm.entity.mergeBatch',
        		{
        			params: {
        				entityTypeId: 3,
        				entityIds: [100, 101, 102]
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.entity.mergeBatch',
                    [
                        'params' => [
                            'entityTypeId' => 3,
                            'entityIds'    => [100, 101, 102]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error merging entities: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.entity.mergeBatch',
            {
                params: {
                    entityTypeId: 3,
                    entityIds: [100, 101, 102]
                }
            },
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.entity.mergeBatch',
            [
                'params' => [
                    'entityTypeId' => 3,
                    'entityIds' => [100, 101, 102]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "STATUS": "SUCCESS",
                "ENTITY_IDS": [101, 102]
            },
            "time": {
                "start": 1750754639.300838,
                "finish": 1750754641.350269,
                "duration": 2.049431085586548,
                "processing": 2.0271031856536865,
                "date_start": "2025-06-24T11:43:59+02:00",
                "date_finish": "2025-06-24T11:44:01+02:00",
                "operating_reset_at": 1750755239,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
STATUS `string`	Status of the operation. Possible values: `SUCCESS` — the merge was successful `CONFLICT` — a data conflict occurred, automatic merging is not possible `ERROR` — an error occurred
ENTITY_IDS `integer[]`	Array of identifiers of the entities that were deleted during the merge
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 0,
            "error_description": "The parameter entityIds must contain at least two elements."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`403`	`Access denied`	The user does not have permission to modify or delete CRM entities
`400`	`The parameter entityTypeId is required.`	The required parameter `entityTypeId` is missing
`400`	`The parameter entityIds does not contain valid elements.`	No elements were provided or found for merging
`400`	`The parameter entityIds must contain at least two elements.`	At least two elements are required for merging
`400`	`Owner was not found`	The object was not found
`400`	`Entity type {entityTypeName} is not supported`	An unsupported object type was specified
`400`	`CRM_FEATURE_RESTRICTION_ERROR`	Plan restriction

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

crm.duplicate.findbycomm

Retrieve Objects with Matching Data

Overview of Methods

Merge Duplicates crm.entity.mergeBatch

Method ParametersMethod Parameters

Parameter paramsParameter params

Method Operation FeaturesMethod Operation Features

Manual Merging in Case of ConflictManual Merging in Case of Conflict

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning