Update the imbot.v2.Command.update

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: owner of the registered bot

The method imbot.v2.Command.update updates the bot's slash command.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId* `integer`	Bot ID
botToken `string`	Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during the chat bot registration
commandId* `integer`	Command ID
fields* `object`	Fields of the command to be updated. The structure of the object is described below

Parameter fields

Name `Type`	Description
command `string`	New command (without `/`)
title `object`	Title of the command in different languages: string value updates the translation value `null` removes the translation absence of the key leaves the translation unchanged Example: `{"de": "Neu", "en": null}` will update `de` and remove `en`
params `object`	Description of parameters in different languages. Similar to `title`, applies only to those languages provided in `title`
common `string`	Common command. Allowed values: `Y`, `N`
hidden `string`	Hidden command. Allowed values: `Y`, `N`
extranetSupport `string`	Extranet support. Allowed values: `Y`, `N`

Code Examples

How to Use Examples in Documentation

Example 1. Updating Translations

Update the title in de and en. Translations in other languages, if any, will remain unchanged.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"b15f6e80ef345c97e23db31e727281f4","commandId":42,"fields":{"title":{"en":"Updated help","de":"Aktualisierte Hilfe"}}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.update

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"commandId":42,"fields":{"title":{"en":"Updated help","de":"Aktualisierte Hilfe"}},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Command.update

try {
          const response = await $b24.callMethod('imbot.v2.Command.update', {
            botId: 456,
            commandId: 42,
            fields: {
              title: {
                en: 'Updated help',
                de: 'Aktualisierte Hilfe',
              },
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Command.update',
                    [
                        'botId' => 456,
                        'commandId' => 42,
                        'fields' => [
                            'title' => [
                                'en' => 'Updated help',
                                'de' => 'Aktualisierte Hilfe',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }

BX24.callMethod(
            'imbot.v2.Command.update',
            {
                botId: 456,
                commandId: 42,
                fields: {
                    title: {
                        en: 'Updated help',
                        de: 'Aktualisierte Hilfe',
                    },
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Command.update',
            [
                'botId' => 456,
                'commandId' => 42,
                'fields' => [
                    'title' => [
                        'en' => 'Updated help',
                        'de' => 'Aktualisierte Hilfe',
                    ],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'result: '. print_r($result['result'], true);
        }

Example 2. Deleting a Translation

Update de and remove en. To delete, pass null as the value.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"b15f6e80ef345c97e23db31e727281f4","commandId":42,"fields":{"title":{"de":"Hilfe","en":null}}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Command.update

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"commandId":42,"fields":{"title":{"de":"Hilfe","en":null}},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imbot.v2.Command.update

try {
          const response = await $b24.callMethod('imbot.v2.Command.update', {
            botId: 456,
            commandId: 42,
            fields: {
              title: {
                de: 'Hilfe',
                en: null,
              },
            },
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Command.update',
                    [
                        'botId' => 456,
                        'commandId' => 42,
                        'fields' => [
                            'title' => [
                                'de' => 'Hilfe',
                                'en' => null,
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: '. print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: '. $exception->getMessage();
        }

BX24.callMethod(
            'imbot.v2.Command.update',
            {
                botId: 456,
                commandId: 42,
                fields: {
                    title: {
                        de: 'Hilfe',
                        en: null,
                    },
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Command.update',
            [
                'botId' => 456,
                'commandId' => 42,
                'fields' => [
                    'title' => [
                        'de' => 'Hilfe',
                        'en' => null,
                    ],
                ],
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: '. $result['error_description'];
        } else {
            echo 'result: '. print_r($result['result'], true);
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "command": {
                    "id": 42,
                    "botId": 456,
                    "command": "/help",
                    "common": false,
                    "hidden": false,
                    "extranetSupport": false
                }
            },
            "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"
            }
        }

Returned Data

Name `Type`	Description
result `object`	Result of the operation
result.command `Command`	Object of the updated command (detailed description)
time `time`	Information about the request execution time

Fields of the Command Object

Field `Type`	Description
id `integer`	Identifier of the command
botId `integer`	Identifier of the bot
command `string`	Text of the command
common `boolean`	Command available in all chats
hidden `boolean`	Command hidden from the command list
extranetSupport `boolean`	Command available to extranet users

Complete description of all object fields can be found on the Objects and Fields page.

Error Handling

HTTP Status: 400, 403

{
            "error": "COMMAND_NOT_FOUND",
            "error_description": "Command 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
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` is not provided. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` is not provided
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Bot is registered by another application
`COMMAND_NOT_FOUND`	Command not found	Command not found or no access
`COMMAND_NAME_EMPTY`	Command name is empty	An empty command name was provided
`COMMAND_NAME_INVALID`	Command name is invalid	Command name must be a string
`COMMAND_ALREADY_EXISTS`	Command already exists	A command with this name is already registered for this bot

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

Get a List of Teams

Update the imbot.v2.Command.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Example 1. Updating TranslationsExample 1. Updating Translations

Example 2. Deleting a TranslationExample 2. Deleting a Translation

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the Command ObjectFields of the Command Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning