Remove User from Chat imopenlines.crm.chat.user.delete

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: imopenlines

Who can execute the method: any user with access to the CRM object

The method imopenlines.crm.chat.user.delete removes a user from the chat associated with the CRM object.

Method Parameters

Required parameters are marked with *

Name
type

Description

CRM_ENTITY_TYPE*
string

Type of the CRM object. Possible values:

  • lead — lead
  • deal — deal
  • company — company
  • contact — contact

CRM_ENTITY*
integer

Identifier of the CRM object.

You can obtain the identifier using the universal method getting a list of CRM entities

USER_ID*
integer

Identifier of the user or bot to be removed from the chat.

You can obtain the user identifier using the user.get and user.search methods

CHAT_ID
integer

Identifier of the chat.

By default, the last chat associated with the CRM object is used.

You can obtain the identifiers of chats associated with the CRM object using the imopenlines.crm.chat.get method

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.chat.user.delete
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"USER_ID":503,"CHAT_ID":1763,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.user.delete
        
// 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
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'imopenlines.crm.chat.user.delete',
            params: {
              CRM_ENTITY_TYPE: 'lead',
              CRM_ENTITY: 1205,
              USER_ID: 503,
              CHAT_ID: 1763,
            },
            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('Chat ID from which the user was removed:', result)
          }
        } 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 deleteUserFromChat() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imopenlines.crm.chat.user.delete',
                params: {
                  CRM_ENTITY_TYPE: 'lead',
                  CRM_ENTITY: 1205,
                  USER_ID: 503,
                  CHAT_ID: 1763,
                },
                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('Chat ID from which the user was removed:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', deleteUserFromChat)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imopenlines.crm.chat.user.delete(
                crm_entity_type="lead",
                crm_entity=1205,
                user_id=503,
                chat_id=1763,
            ).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(
                    'imopenlines.crm.chat.user.delete',
                    [
                        'CRM_ENTITY_TYPE' => 'lead',
                        'CRM_ENTITY' => 1205,
                        'USER_ID' => 503,
                        'CHAT_ID' => 1763,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'imopenlines.crm.chat.user.delete',
            {
                CRM_ENTITY_TYPE: 'lead',
                CRM_ENTITY: 1205,
                USER_ID: 503,
                CHAT_ID: 1763
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.crm.chat.user.delete',
            [
                'CRM_ENTITY_TYPE' => 'lead',
                'CRM_ENTITY' => 1205,
                'USER_ID' => 503,
                'CHAT_ID' => 1763,
            ]
        );
        
        print_r($result);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imopenlines.crm.chat.user.delete", b24.Params{
        	"CRM_ENTITY_TYPE": "lead",
        	"CRM_ENTITY":      1205,
        	"USER_ID":         503,
        	"CHAT_ID":         1763,
        })
        if err != nil {
        	return fmt.Errorf("imopenlines.crm.chat.user.delete: %w", err)
        }
        
        var value b24.ID
        if err := json.Unmarshal(res.Result, &value); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("result:", value)
        

Response Handling

HTTP Status: 200

{
            "result": 1763,
            "time": {
                "start": 1773814361,
                "finish": 1773814361.128245,
                "duration": 0.12824511528015137,
                "processing": 0,
                "date_start": "2026-03-18T09:12:41+01:00",
                "date_finish": "2026-03-18T09:12:41+01:00",
                "operating_reset_at": 1773814961,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the chat from which the user was removed.

If CHAT_ID is not provided and the chat for the CRM object is not found or does not exist, the method will return "result":0

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "The value of an argument 'CRM_ENTITY' has an invalid type"
        }
        

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

Status

Code

Description

Value

403

ACCESS_DENIED

Access denied! You don't have access to join user to chat

Possible reasons:

  • invalid or non-existent CRM_ENTITY_TYPE specified
  • the user executing the method does not have access to the CRM object

400

CRM_CHAT_EMPTY_USER

Empty User ID

Required parameter USER_ID is not specified

400

CRM_CHAT_EMPTY_CRM_DATA

Empty CRM data

Required parameters CRM_ENTITY_TYPE and CRM_ENTITY are not provided

400

ERROR_ARGUMENT

The value of an argument 'CRM_ENTITY' has an invalid type

The parameter CRM_ENTITY is passed in an incorrect format

400

IM_NOT_INSTALLED

Messenger is not installed.

The im module is not installed

400

CHAT_NOT_IN_CRM

Chat does not belong to the CRM object being checked

Possible reasons:

  • the chat is not linked to the CRM object
  • the chat with the specified CHAT_ID does not exist

403

CHAT_DELETE_USER_PERMISSION_DENIED

You don't have access to delete a user from this chat

The user does not have permission to remove a participant from the chat

400

CRM_CHAT_USER_NOT_ACTIVE

User not active

The user being removed with USER_ID is not active or does not exist

400

WRONG_REQUEST

You don't have access or user already not in chat

The user has already been removed from the chat or is unavailable for removal

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