Merge Duplicates crm.entity.mergeBatch

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: crm

Who can execute the method: a user with permission to modify the main entity and permission to delete the remaining entities being merged

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:

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.

Permissions are checked for each entity separately. The main entity requires read and modify permissions, and the remaining ones require read and delete permissions. Permissions are not checked for the administrator.

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 -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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type MergeBatchResult = {
          STATUS: 'SUCCESS' | 'CONFLICT' | 'ERROR'
          ENTITY_IDS: number[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<MergeBatchResult>({
            method: 'crm.entity.mergeBatch',
            params: {
              params: {
                entityTypeId: 3,
                entityIds: [100, 101, 102],
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Merge status:', result.STATUS, '| Deleted entity IDs:', result.ENTITY_IDS)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function mergeEntities() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.entity.mergeBatch',
                params: {
                  params: {
                    entityTypeId: 3,
                    entityIds: [100, 101, 102],
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Merge status:', result.STATUS, '| Deleted entity IDs:', result.ENTITY_IDS)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', mergeEntities)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.entity.merge_batch(
                params={
                    "entityTypeId": 3,
                    "entityIds": [100, 101, 102],
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API Error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK Error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.entity.mergeBatch", b24.Params{
        	"params": b24.Params{
        		"entityTypeId": 3,
        		"entityIds":    []int{100, 101, 102},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.entity.mergeBatch: %w", err)
        }
        
        var item struct {
        	Status string `json:"STATUS"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Status)
        

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+03:00",
                "date_finish": "2025-06-24T11:44:01+03: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 contains at least two elements."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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.

Required parameter entityTypeId is not specified

400

The parameter entityIds does not contains valid elements.

No elements were provided or found for merging

400

The parameter entityIds must contains 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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning