Unregister Chat Bot imbot.unregister

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imbot

Who can execute the method: an authorized user of the application that registered the chat bot

DEPRECATED

Development of this method has been halted. Please use imbot.v2.Bot.unregister.

The method imbot.unregister removes a chat bot.

When deleting the bot, personal chats with users will also be deleted.

Method Parameters

Required parameters are marked with *

Name
Type

Description

BOT_ID*
integer

The identifier of the chat bot. The value must be greater than 0.

You can obtain the bot identifier using the imbot.bot.list method.

CLIENT_ID
string

This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot.

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 '{"BOT_ID":39,"CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.unregister

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.unregister

try {
          const response = await $b24.callMethod('imbot.unregister', {
            BOT_ID: 39,
          });
        
          const { result } = response.getData();
          console.log('Unregistered:', result);
        } catch (error) {
          console.error('Error unregistering bot:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.unregister',
                    [
                        'BOT_ID' => 39,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Unregistered: ' . ($result->data() ? 'true' : 'false');
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error unregistering bot: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.unregister',
            {
                BOT_ID: 39,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.unregister',
            [
                'BOT_ID' => 39,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Unregistered: ' . ($result['result'] ? 'true' : 'false');
        }

Response Handling

HTTP Code: 200

{
            "result": true,
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `boolean`	`true` if the chat bot was deleted without error
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400, 403

{
            "error": "BOT_ID_ERROR",
            "error_description": "Bot 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	Value
`WRONG_AUTH_TYPE`	Access for this method not allowed by session authorization.	The method was called with session authorization instead of OAuth or webhook.
`ACCESS_DENIED`	Access denied! Client ID not specified	Unable to determine the application: `clientId` authorization is missing and `CLIENT_ID` was not provided.
`BOT_ID_ERROR`	Bot not found	Bot not found.
`APP_ID_ERROR`	Bot was installed by another REST application	The provided `BOT_ID` belongs to another application.
`WRONG_REQUEST`	Bot can't be deleted	The bot cannot be deleted.

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Retrieve a List of Chatbots

Overview of Methods

Unregister Chat Bot imbot.unregister

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