метод REST scope: базовый

user.option.set

Привязать данные к пользователю и приложению

Кто может выполнять: любой пользователь

Описание

Метод user.option.set привязывает данные к приложению и пользователю.

Приложение может привязываться к установившему пользователю, если это приложение без пользовательского интерфейса или к пользователю, с которым взаимодействует, если это приложение с пользовательским интерфейсом.

Параметры

options array обязательный

Массив, где ключ — название сохраняемого свойства, а значение — значение свойства.
Если передать значение с новым ключом, то метод его запишет, а если существующее — обновит

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "options": {
        "data": "value",
        "data2": "value2"
    }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.option.set

Ответ

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 boolean

Возвращается true, если настройки сохранены

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":"ArgumentNullException",
    "error_description":"options is empty"
}
Код Описание Значение
ArgumentNullException options is empty Пустой массив options
AccessException Application context required Метод вызван вне контекста приложения
AccessException User authorization required Пользователь не авторизован

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.