Set Settings for User BX24.userOption.set

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, string value): void;

The method BX24.userOption.set sets the value of the setting named name for the current user. The value is set 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'});
        });

How to Use Examples in Documentation

Continue Learning

Previous
Overview of Methods
Next
Get User Settings