Update Application Data in Chat imbot.app.update

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

Who can execute the method: any user

The method imbot.app.update updates application data in the chat.

Warning

The required fields are the application ID and one of the necessary fields for editing. If both JS and IFRAME methods are specified in one command, only JS will be used.

Method Parameters

Required parameters are marked with *

Name

Example

Description

APP_ID*

13

Chat identifier

IFRAME

'https://marta.bitrix.com/iframe/echo.php'

URL of the frame

IFRAME_WIDTH

'350'

Desired width of the frame. Minimum value - 250px

IFRAME_HEIGHT

'150'

Desired height of the frame. Minimum value - 50px

JS_METHOD

'SEND'

JS_PARAM

'/help'

HASH

'register'

Token for accessing your frame, 32 characters

ICON_FILE

'/* base64 image */'

Icon of your application - base64

CONTEXT

'BOT'

Application context

EXTRANET_SUPPORT

'N'

Is the command available to extranet users, default N

LIVECHAT_SUPPORT

'N'

Online chat support

IFRAME_POPUP

'N'

iframe will open with the ability to move within the messenger, switching between dialogs will not close such a window

LANG

Array(...)

Array of translations, it is advisable to specify at least for DE and EN

LANGUAGE_ID (LANG)

'en'

Language identifier for translation

TITLE (LANG)

'Echobot IFRAME'

Title for the button or command in the specified language

DESCRIPTION (LANG)

'Open Echobot IFRAME app'

Command description in the specified language

COPYRIGHT (LANG)

'Bitrix24'

Copyright

Code Example

Note

This example uses the restCommand function. This is a method for sending data to Bitrix24. You can use your own function to call the method, the JavaScript method BX24.callMethod or industry standard B24PhpSDK.

How to Use Examples in Documentation

$result = restCommand(
            'imbot.app.update',
            Array(
                'APP_ID' => 13,
                'FIELDS' => Array(
                    'IFRAME' => 'https://marta.bitrix.com/iframe/echo.php',
                    'IFRAME_WIDTH' => '350',
                    'IFRAME_HEIGHT' => '150',
                    'JS_METHOD' => 'SEND',
                    'JS_PARAM' => '/help',
                    'HASH' => 'register',
                    'ICON_FILE' => '/* base64 image */',
                    'CONTEXT' => 'BOT',
                    'EXTRANET_SUPPORT' => 'N',
                    'LIVECHAT_SUPPORT' => 'N',
                    'IFRAME_POPUP' => 'N',
                    'LANG' => Array(
                        Array(
                            'LANGUAGE_ID' => 'en',
                            'TITLE' => 'Echobot IFRAME',
                            'DESCRIPTION' => 'Open Echobot IFRAME app',
                            'COPYRIGHT' => 'Bitrix24'
                        ),
                    )
                )
            ),
            $_REQUEST["auth"]
        );

Successful Response

true

Possible Error Codes

Code

Description

CHAT_APP_ID_ERROR

Application not found

APP_ID_ERROR

The chat application does not belong to this rest application. You can only work with chat applications installed within the current rest application

IFRAME_HTTPS

The link to IFRAME must be on a site with an active HTTPS certificate

WRONG_REQUEST

Something went wrong

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

Previous
Register a Chat Application
Next
Unregister a Chat Application