Skip to main content

Установка настроек пользователя

Метод и конечная точка​

POST /users.setPreferences

Описание​

Устанавливает настройки для текущего пользователя или указанного userId.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
userIdнетstringИдентификатор пользователя (если не указан, применяется к текущему)
dataдаobjectОбъект с настройками

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.setPreferences' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"data": {
"language": "<LANGUAGE>",
"enableAutoAway": true,
"idleTimeLimit": 300
}
}'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <LANGUAGE> — код языка (например, ru, en).

Ответ​

200 — Basic API response with success status — Настройки обновлены. Пример вывода:

{
"success": true
}