Update the deal's connection with the CRM entity crm.activity.binding.move

Scope: crm

Who can execute the method: user with editing access permission for CRM entities

The method crm.activity.binding.move updates the connection of a deal with a CRM entity.

Method Parameters

Required parameters are marked with *

Name `type`	Description
activityId* `integer`	Identifier of the deal in the timeline, for example `999`
sourceEntityTypeId* `integer`	Identifier of the CRM object type to which the deal is linked, for example `2` for a deal
sourceEntityId* `integer`	Identifier of the CRM entity to which the deal is linked, for example `1`
targetEntityTypeId* `integer`	Identifier of the CRM object type to which the deal needs to be linked, for example `2` for a deal
targetEntityId* `integer`	Identifier of the CRM entity to which the deal needs to be linked, for example `100`

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 '{"activityId":999, "sourceEntityTypeId":2, "sourceEntityId": 1, "targetEntityTypeId":2, "targetEntityId": 100}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.binding.move

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"activityId":999,"sourceEntityTypeId":2,"sourceEntityId":1,"targetEntityTypeId":2,"targetEntityId":100,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.activity.binding.move

try
        {
        	const response = await $b24.callMethod(
        		'crm.activity.binding.move',
        		{
        			activityId: 999, // ID of the deal
        			sourceEntityTypeId: 2, // Type of the object to which the deal is linked
        			sourceEntityId: 1, // ID of the entity to which the deal is linked
        			targetEntityTypeId: 2, // Type of the object to which the deal will be linked
        			targetEntityId: 100 // ID of the entity to which the deal will be linked
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Result:', result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.activity.binding.move',
                    [
                        'activityId'         => 999,
                        'sourceEntityTypeId' => 2,
                        'sourceEntityId'     => 1,
                        'targetEntityTypeId' => 2,
                        'targetEntityId'     => 100,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error moving activity binding: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.activity.binding.move',
            {
                activityId: 999, // ID of the deal
                sourceEntityTypeId: 2, // Type of the object to which the deal is linked
                sourceEntityId: 1, // ID of the entity to which the deal is linked
                targetEntityTypeId: 2, // Type of the object to which the deal will be linked
                targetEntityId: 100 // ID of the entity to which the deal will be linked
            },
            function(result) {
                if (result.error()) {
                    console.error('Error:', result.error()); 
                } else {
                    console.log('Result:', result.data()); 
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.activity.binding.move',
            [
                'activityId' => 999, // ID of the deal
                'sourceEntityTypeId' => 2, // Type of the object to which the deal is linked
                'sourceEntityId' => 1, // ID of the entity to which the deal is linked
                'targetEntityTypeId' => 2, // Type of the object to which the deal will be linked
                'targetEntityId' => 100 // ID of the entity to which the deal will be linked
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 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
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Result of the operation. Returns `true` if the connection was successfully changed, otherwise returns `false`
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "NOT_FOUND",
            "error_description": "Element not found"
        }

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
`100`	Required fields not provided
`NOT_FOUND`	Element not found
`OWNER_NOT_FOUND`	Owner of the element not found
`SOURCE_AND_TARGET_ENTITY_TYPES_ARE_NOT_EQUAL`	Cannot move the deal from one CRM object type to another
`SOURCE_AND_TARGET_ENTITY_ID_ARE_EQUAL_ERROR`	Cannot move the deal to the same deal
`ACCESS_DENIED`	Insufficient rights to perform the operation
`ACTIVITY_IS_ALREADY_BOUND`	The deal is already linked to this entity
`BINDING_NOT_FOUND`	The deal is not linked to the specified entity

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

Add CRM Activity Relationship with CRM Entity

Retrieve List of CRM Activity Relationships

Update the deal's connection with the CRM entity crm.activity.binding.move

Method ParametersMethod Parameters

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