Объединить дубликаты crm.entity.mergeBatch

Scope: crm

Кто может выполнять метод: администратор

Метод crm.entity.mergeBatch объединяет несколько элементов в один.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

params*
object

Объект с элементами для объединения (подробное описание)

Параметр params

Название
тип

Описание

entityTypeId*
integer

Идентификатор типа объекта CRM. Возможные значения:

entityIds*
integer[]

Массив идентификаторов элементов, которые необходимо объединить. Минимум два элемента

Особенности работы метода

Объединять можно только элементы одного типа: лид с лидом, контакт с контактом, элемент смарт-процесса с ID 128 c элементом смарт-процесса с ID 128.

Полное автоматическое объединение доступно в нескольких случаях:

  • элементы идентичны друг другу,
  • элементы не идентичны, но разница в значениях полей не требует ручной обработки. Например, в одном элементе поле заполнено, а в другом это же поле пустое — будет сохранено значение из заполненного поля.

Главным элементом при объединении будет тот, ID которого указан первым в массиве entityIds. В главный элемент будет перенесена информация из других элементов. Все элементы кроме главного будут удалены после успешного объединения.

Ручное объединение при конфликте

Если метод возвращает статус CONFLICT, продолжить объединение можно вручную в интерфейсе Битрикс24 по ссылке:

  • Контакты: /crm/contact/merge/?id=1,2,3
  • Компании: /crm/company/merge/?id=1,2,3
  • Лиды: /crm/lead/merge/?id=1,2,3
  • Сделки: /crm/deal/merge/?id=1,2,3

Параметр id содержит идентификаторы объединяемых элементов через запятую.

  • Счета: /crm/type/31/merge/?id[]=1&id[]=2
  • Предложения: /crm/type/7/merge/?id[]=1&id[]=2
  • Смарт-процессы: /crm/type/128/merge/?id[]=1&id[]=2

Параметр id[] содержит идентификаторы объединяемых элементов, переданные в виде повторяющегося параметра.

Примеры кода

Как использовать примеры в документации

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>';

Обработка ответа

HTTP-статус: 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
            }
        }

Возвращаемые данные

Название
тип

Описание

STATUS
string

Статус выполнения операции. Возможные значения:

  • SUCCESS — объединение прошло успешно
  • CONFLICT — возник конфликт данных, автоматическое объединение невозможно
  • ERROR — произошла ошибка

ENTITY_IDS
integer[]

Массив идентификаторов элементов, которые были удалены при объединении

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

403

Access denied

У пользователя нет прав на изменение или удаление элементов CRM

400

The parameter entityTypeId is required.

Не указан обязательный параметр entityTypeId

400

The parameter entityIds does not contains valid elements.

Не переданы или не найдены элементы для объединения

400

The parameter entityIds must contains at least two elements.

Для объединения требуется минимум два элемента

400

Owner was not found

Объект не найден

400

Entity type {entityTypeName} is not supported

Указан неподдерживаемый тип объекта

400

CRM_FEATURE_RESTRICTION_ERROR

Ограничение тарифа

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить объекты с совпадающими данными
Следующая
Обзор методов