Set Configurations for a User BX24.userOption.set

Method Parameters
Code Example
Return Value
Continue Learning

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.userOption.set(string name, mixed value): void;

The BX24.userOption.set method sets the value of the value configuration with the name name for the current user. The value is applied immediately.

Method Parameters

Required parameters are marked with *

Name `type`	Description
name* `string`	Parameter code
value* `mixed`	Parameter value

Code Example

BX24.init(() => {
            BX24.userOption.set('param_str', 'str');
            BX24.userOption.set('param_numb', 1);
            BX24.userOption.set('param_obj', {foo: 'bar'});
        });