Сохранить настройки пользователя user.option.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
базовыйКто может выполнять метод: любой авторизованный пользователь в контексте приложения
Метод user.option.set сохраняет настройки текущего пользователя для приложения. Каждый пользователь хранит свои значения. Прочитать их можно методом user.option.get.
Настройки сохраняются для пользователя, чьим токеном выполнен вызов. Для приложения без пользовательского интерфейса это обычно пользователь, установивший приложение, для приложения с пользовательским интерфейсом — пользователь, который с ним работает.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
options |
Объект настроек: ключ — название настройки, значение — ее значение. Передавайте Перезаписываются только переданные ключи, остальные сохраненные настройки не меняются. Значение сохраняется с тем типом, с каким пришло в запросе: из параметров формы — строкой, из JSON-тела — числом, логическим значением, массивом или объектом. Метода удаления нет: ключ с пустой строкой остается в настройках с пустым значением. Если параметр |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"options": {
"data": "value",
"data2": "value2"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.option.set
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'user.option.set',
params: {
options: {
data: 'value',
data2: 'value2',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('User options saved:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function setUserOption() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.option.set',
params: {
options: {
data: 'value',
data2: 'value2',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('User options saved:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setUserOption)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.user.option.set(
options={
"data": "value",
"data2": "value2",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'user.option.set',
[
'options' => [
'data' => 'value',
'data2' => 'value2',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo $result->data();
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting user options: ' . $e->getMessage();
}
BX24.callMethod(
'user.option.set',
{
"options": {
"data": "value",
"data2": "value2",
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'user.option.set',
[
'options' => [
'data' => 'value',
'data2' => 'value2'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.option.set", b24.Params{
"options": b24.Params{
"data": "value",
"data2": "value2",
},
})
if err != nil {
return fmt.Errorf("user.option.set: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1722001311.94644,
"finish": 1722001311.98622,
"duration": 0.0397801399230957,
"processing": 0.000041961669921875,
"date_start": "2024-07-26T13:41:51+00:00",
"date_finish": "2024-07-26T13:41:51+00:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Возвращается |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'options' is null or empty",
"argument": "options"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Argument 'options' is null or empty |
Не передано ни одной настройки: параметр |
|
|
|
Access denied! Application context required |
Метод вызван вне контекста приложения, например через входящий вебхук |
|
|
|
Access denied! User authorization required |
Запрос выполнен без авторизованного пользователя |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |