Update the imbot.v2.Command.update Team
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:
imbotWho 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 |
Description |
|
botId* |
Bot ID |
|
botToken |
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* |
Command ID |
|
fields* |
Fields of the command to be updated. The structure of the object is described below |
Parameter fields
|
Name |
Description |
|
command |
New command (without |
|
title |
Command title in different languages:
Example: |
|
params |
Description of parameters in different languages. Similar to |
|
common |
Common command. Allowed values: |
|
hidden |
Hidden command. Allowed values: |
|
extranetSupport |
Extranet support. Allowed values: |
Boolean parameters accept
trueandfalse. If the client does not support JSON boolean, strings"Y"and"N"can be passed.
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 -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);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.command.update(
bot_id=456,
command_id=42,
fields={
"title": {
"en": "Updated help",
"ru": "Updated command",
},
},
).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(
'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);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imbot.v2.Command.update", b24.Params{
"botId": 456,
"botToken": "b15f6e80ef345c97e23db31e727281f4",
"commandId": 42,
"fields": b24.Params{
"title": b24.Params{
"en": "Updated help",
},
},
})
if err != nil {
return fmt.Errorf("imbot.v2.Command.update: %w", err)
}
// The method wraps the response in an object with the "command" key.
raw, ok := b24.Unwrap(res.Result, "command")
if !ok {
return fmt.Errorf("no command key in the response")
}
var item struct {
ID b24.ID `json:"id"`
BotID b24.ID `json:"botId"`
Command string `json:"command"`
Common bool `json:"common"`
Hidden bool `json:"hidden"`
ExtranetSupport bool `json:"extranetSupport"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.BotID)
Example 2. Deleting a Translation
Update de and remove en. To delete, pass null as the value.
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);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.command.update(
bot_id=456,
bot_token="b15f6e80ef345c97e23db31e727281f4",
command_id=42,
fields={
"title": {
"ru": "Help",
"en": None,
},
},
).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(
'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);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imbot.v2.Command.update", b24.Params{
"botId": 456,
"botToken": "b15f6e80ef345c97e23db31e727281f4",
"commandId": 42,
"fields": b24.Params{
"title": b24.Params{
"en": nil,
},
},
})
if err != nil {
return fmt.Errorf("imbot.v2.Command.update: %w", err)
}
// The method wraps the response in an object with the "command" key.
raw, ok := b24.Unwrap(res.Result, "command")
if !ok {
return fmt.Errorf("no command key in the response")
}
var item struct {
ID b24.ID `json:"id"`
BotID b24.ID `json:"botId"`
Command string `json:"command"`
Common bool `json:"common"`
Hidden bool `json:"hidden"`
ExtranetSupport bool `json:"extranetSupport"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.BotID)
Response Handling
HTTP Status: 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 |
Description |
|
result |
Result of the operation |
|
result.command |
Object of the updated command (detailed description) |
|
time |
Information about the request execution time |
Fields of the Command Object
|
Field |
Description |
|
id |
Command identifier |
|
botId |
Bot identifier |
|
command |
Command text |
|
common |
Command available in all chats |
|
hidden |
Command hidden from the command list |
|
extranetSupport |
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Bot token is not specified |
|
|
|
Bot ID is required |
|
|
|
Bot not found |
Bot not found |
|
|
Bot is registered by another application |
Bot registered by another application |
|
|
Command not found |
Command not found or no access |
|
|
Command name is empty |
Empty command name provided |
|
|
Command name is invalid |
Command name must be a string |
|
|
Command already exists |
Command with this name is already registered for this bot |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |