Update the imbot.command.update

Scope: imbot

Who can execute the method: a user of the application that registered the chatbot

The method imbot.command.update updates the parameters of a registered chatbot command.

Method Parameters

Required parameters are marked with *

Name `type`	Description
COMMAND_ID* `integer`	Identifier of the command to update
FIELDS* `object`	Object containing fields to update. The structure is described below
CLIENT_ID `string`	This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified during the chatbot registration

At least one modifiable parameter must be provided in FIELDS. If an empty object is passed, the method will return an error.

FIELDS Parameter

Name `type`	Description
COMMAND `string`	Command text
EVENT_COMMAND_ADD `string`	URL of the event handler ONIMCOMMANDADD
HIDDEN `string`	Command visibility: `Y` - hidden `N` - visible
EXTRANET_SUPPORT `string`	Availability for extranet users: `Y` - available `N` - not available
LANG `array`	Array of command localizations. The structure is described below

FIELDS.LANG Parameter

Name `type`	Description
LANGUAGE_ID* `string`	Language identifier, e.g., `de` or `en`
TITLE* `string`	Command title in the selected language
PARAMS `string`	Command parameter hints in the selected language

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 '{"COMMAND_ID":99,"FIELDS":{"COMMAND":"echo2","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","HIDDEN":"N","EXTRANET_SUPPORT":"Y","LANG":[{"LANGUAGE_ID":"de","TITLE":"Echo 2","PARAMS":"text"},{"LANGUAGE_ID":"en","TITLE":"Echo 2","PARAMS":"text"}]},"CLIENT_ID":"**put_your_client_id_here**"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.command.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"COMMAND_ID":99,"FIELDS":{"COMMAND":"echo2","EVENT_COMMAND_ADD":"https://example.com/bot/command.php","HIDDEN":"N","EXTRANET_SUPPORT":"Y","LANG":[{"LANGUAGE_ID":"de","TITLE":"Echo 2","PARAMS":"text"},{"LANGUAGE_ID":"en","TITLE":"Echo 2","PARAMS":"text"}]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imbot.command.update

try
        {
            const response = await $b24.callMethod(
                'imbot.command.update',
                {
                    COMMAND_ID: 99,
                    FIELDS: {
                        COMMAND: 'echo2',
                        EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                        HIDDEN: 'N',
                        EXTRANET_SUPPORT: 'Y',
                        LANG: [
                            { LANGUAGE_ID: 'de', TITLE: 'Echo 2', PARAMS: 'text' },
                            { LANGUAGE_ID: 'en', TITLE: 'Echo 2', PARAMS: 'text' }
                        ]
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Updated command with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.command.update',
                    [
                        'COMMAND_ID' => 99,
                        'FIELDS' => [
                            'COMMAND' => 'echo2',
                            'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                            'HIDDEN' => 'N',
                            'EXTRANET_SUPPORT' => 'Y',
                            'LANG' => [
                                ['LANGUAGE_ID' => 'de', 'TITLE' => 'Echo 2', 'PARAMS' => 'text'],
                                ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo 2', 'PARAMS' => 'text']
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating command: ' . $e->getMessage();
        }

BX24.callMethod(
            'imbot.command.update',
            {
                COMMAND_ID: 99,
                FIELDS: {
                    COMMAND: 'echo2',
                    EVENT_COMMAND_ADD: 'https://example.com/bot/command.php',
                    HIDDEN: 'N',
                    EXTRANET_SUPPORT: 'Y',
                    LANG: [
                        { LANGUAGE_ID: 'de', TITLE: 'Echo 2', PARAMS: 'text' },
                        { LANGUAGE_ID: 'en', TITLE: 'Echo 2', PARAMS: 'text' }
                    ]
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.command.update',
            [
                'COMMAND_ID' => 99,
                'FIELDS' => [
                    'COMMAND' => 'echo2',
                    'EVENT_COMMAND_ADD' => 'https://example.com/bot/command.php',
                    'HIDDEN' => 'N',
                    'EXTRANET_SUPPORT' => 'Y',
                    'LANG' => [
                        ['LANGUAGE_ID' => 'de', 'TITLE' => 'Echo 2', 'PARAMS' => 'text'],
                        ['LANGUAGE_ID' => 'en', 'TITLE' => 'Echo 2', 'PARAMS' => 'text']
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1772103002,
                "finish": 1772103003.109342,
                "duration": 1.109342098236084,
                "processing": 0,
                "date_start": "2026-02-26T13:50:02+01:00",
                "date_finish": "2026-02-26T13:50:03+01:00",
                "operating_reset_at": 1772103603,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	`true` if the command was successfully updated
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "WRONG_REQUEST",
            "error_description": "Update fields can't be empty"
        }

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
`COMMAND_ID_ERROR`	Command not found	Command not found
`APP_ID_ERROR`	Command was installed by another rest application	Command registered by another application
`EVENT_COMMAND_ADD_ERROR`	Wrong handler URL	Invalid event handler URL
`WRONG_REQUEST`	Update fields can't be empty	No fields provided for update
`WRONG_REQUEST`	Command can't be updated	Failed to update command

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 Team

Send Response to Team

Update the imbot.command.update

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

FIELDS.LANG ParameterFIELDS.LANG Parameter

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