Set Configurations for the BX24.appOption.set App

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.

BX24.appOption.set(string name, mixed value[, Function callback]): void;
        

The BX24.appOption.set method sets general configurations for the current application.

Setting application configuration values is only available to users with application management permissions (see BX24.isAdmin). An on-completion handler may be required for application configurations (see parameter callback below).

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

Parameter code

value*
mixed

Parameter value

callback
function

Callback after saving. The current application settings will be passed as an argument

Code Example

BX24.init(() => {
            BX24.appOption.set('param_str', 'str1', (params) => console.log(params));
            BX24.appOption.set('param_numb', 1);
        });
        

How to Use Examples in Documentation

Return Value

The method returns nothing. If the callback parameter is passed, current application settings will be passed as a function argument callback.

Continue Learning