Update Call List Composition crm.calllist.update

Scope: crm

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

The crm.calllist.update method allows you to add or remove participants from an existing call list and update the associated CRM form.

Method Parameters

Required parameters are marked with *

Name `type`	Description
LIST_ID* `integer`	Identifier of the call list
ENTITY_TYPE* `string`	Type of entity: `CONTACT` — contact, `COMPANY` — company
ENTITIES* `array`	Array of `ID`s of contacts or companies, which can be obtained using the crm.item.list method
WEBFORM_ID `integer`	`ID` of the CRM form that will be displayed in the call form. The `ID` can be found in the list of forms in Bitrix24 https://your-domain.com/crm/webform/

Method Operation Features

The method overwrites the ENTITIES array. To add an element, include both current and new IDs in the request:

Current IDs: [1,2,3].
New IDs: [4].
Send: [1,2,3,4].

To remove an element, send only those IDs that should remain in the list:

Current IDs: [1,2,3].
Remove: [2].
Send: [1,3].

The method overwrites the WEBFORM_ID field. If the WEBFORM_ID field is not provided when calling the method, it will be cleared.

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" \
             -d '{"LIST_ID":123,"ENTITY_TYPE":"CONTACT","ENTITIES":[1,2,3],"WEBFORM_ID":5}' \
             https://**your_bitrix24**/rest/**user_id**/**webhook**/crm.calllist.update

curl -X POST \
             -H "Content-Type: application/json" \
             -d '{"LIST_ID":123,"ENTITY_TYPE":"CONTACT","ENTITIES":[1,2,3],"WEBFORM_ID":5,"auth":"**put_access_token_here**"}' \
             https://**your_bitrix24**/rest/crm.calllist.update

try
        {
        	const response = await $b24.callMethod(
        		'crm.calllist.update',
        		{
        			LIST_ID: 123,
        			ENTITY_TYPE: 'CONTACT',
        			ENTITIES: [1, 2, 3],
        			WEBFORM_ID: 5
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error()) {
        		console.error(result.error());
        	} else {
        		console.dir(result);
        	}
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.calllist.update',
                    [
                        'LIST_ID'     => 123,
                        'ENTITY_TYPE' => 'CONTACT',
                        'ENTITIES'    => [1, 2, 3],
                        'WEBFORM_ID'  => 5,
                    ]
                );
        
            $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 updating call list: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.calllist.update",
            {
                LIST_ID: 123,
                ENTITY_TYPE: "CONTACT",
                ENTITIES: [1,2,3],
                WEBFORM_ID: 5
            },
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.calllist.update',
            [
                'LIST_ID' => 123,
                'ENTITY_TYPE' => 'CONTACT',
                'ENTITIES' => [1,2,3],
                'WEBFORM_ID' => 5
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1752562914.533195,
                "finish": 1752562914.606445,
                "duration": 0.07325005531311035,
                "processing": 0.044027090072631836,
                "date_start": "2025-07-15T10:01:54+02:00",
                "date_finish": "2025-07-15T10:01:54+02:00",
                "operating_reset_at": 1752563514,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, contains `true` in case of success
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": "Invalid parameters.",
            "error_description": "Invalid parameters were provided."
        }

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
`400`	`Invalid parameters`	Invalid parameters were provided
`400`	`Incorrect entity type`	Unsupported entity type specified
`400`	`Entities is not array`	The ENTITIES parameter is not an array
`400`	`Incorrect entities id`	Invalid IDs of elements were provided
`400`	`Incorrect list id or access denied`	Invalid list identifier or no access
`400`	`Discrepancy between the type of call participants and incoming type`	Mismatch between participant type and provided type
`400`	`Incorrect webform id`	Invalid ID of the CRM form

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

Get a List of Call List Statuses

Overview of Methods

Update Call List Composition crm.calllist.update

Method ParametersMethod Parameters

Method Operation FeaturesMethod Operation Features

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