Удалить связь дела с элементом CRM crm.activity.binding.delete

Scope: crm

Кто может выполнять метод: пользователь c правом редактирования элементов CRM

Метод crm.activity.binding.delete удаляет cвязь дела с элементом CRM. Если дело привязано только к одному элементу, удалить эту привязку нельзя.

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

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

Название
тип

Описание

activityId*
integer

Целочисленный идентификатор дела в таймлайне, например 999

entityTypeId*
integer

Целочисленный идентификатор типа объекта CRM, с которым удаляем связь дела, например 2 для сделки

entityId*
integer

Целочисленный идентификатор элемента CRM, с которым удаляем связь дела, например 1

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"activityId":999, "entityTypeId":2, entityId: 1}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.binding.delete
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"activityId":999, "entityTypeId":2, "entityId": 1, "auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.binding.delete
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.activity.binding.delete',
        		{
        			activityId: 999, // ID дела
        			entityTypeId: 2, // ID типа объекта CRM
        			entityId: 1 // ID элемента CRM
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Результат:', result);
        }
        catch( error )
        {
        	console.error('Ошибка:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.binding.delete',
                    [
                        'activityId'   => 999, // ID дела
                        'entityTypeId' => 2, // ID типа объекта CRM
                        'entityId'     => 1 // ID элемента CRM
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Результат: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Ошибка: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.activity.binding.delete',
            {
                activityId: 999, // ID дела
                entityTypeId: 2, // ID типа объекта CRM
                entityId: 1 // ID элемента CRM
            },
            function(result) {
                if (result.error()) {
                    console.error('Ошибка:', result.error()); 
                } else {
                    console.log('Результат:', result.data()); 
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.binding.delete',
            [
                'activityId' => 999, // ID дела
                'entityTypeId' => 2, // ID типа объекта CRM
                'entityId' => 1 // ID элемента CRM
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }
        

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

Название
тип

Описание

result
boolean

Результат операции. Возвращает true если связь успешно создана, иначе — false

time
time

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

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

HTTP-статус: 400

{
            "error": "NOT_FOUND",
            "error_description": "Элемент не найден"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

100

Не переданы обязательные поля

NOT_FOUND

Элемент не найден

OWNER_NOT_FOUND

Владелец элемента не найден

ACCESS_DENIED

Недостаточно прав для выполнении операции

BINDING_NOT_FOUND

Дело не привязано к этому элементу

LAST_BINDING_CANNOT_BE_DELETED

Нельзя удалять единственную привязку дела к сущности

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

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

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

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