Обновление данных пользователя

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

POST /users.update

Описание

Обновляет данные существующего пользователя. Для обновления пароля требуется право edit-other-user-password.

Параметры

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

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор пользователя для обновления
data.email	нет	string	Новый адрес электронной почты
data.name	нет	string	Новое полное имя пользователя
data.password	нет	string	Новый пароль
data.username	нет	string	Новое имя пользователя в формате firstname.lastname
data.phone	нет	string	Новый номер телефона
data.active	нет	boolean	Статус активности пользователя
data.bio	нет	string	Описание пользователя
data.nickname	нет	string	Псевдоним пользователя
data.statusText	нет	string	Текстовый статус пользователя
data.roles	нет	array	Роли пользователя
data.joinDefaultChannels	нет	boolean	Добавлять в каналы по умолчанию
data.requirePasswordChange	нет	boolean	Требовать смену пароля при следующем входе
data.setRandomPassword	нет	boolean	Установить случайный пароль
data.verified	нет	boolean	Статус подтверждения email
data.customFields	нет	object	Пользовательские поля

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.update' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "userId": "<USER_ID_TO_UPDATE>",
  "data": {
  "name": "<NEW_NAME>",
  "statusText": "<NEW_STATUS_TEXT>",
  "active": true
  }
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <USER_ID_TO_UPDATE> — идентификатор пользователя, данные которого необходимо обновить;
• <NEW_NAME> — новое полное имя пользователя;
• <NEW_STATUS_TEXT> — новый текстовый статус пользователя.

Ответ

200 — Update User — Пользователь обновлен. Пример вывода:

{
  "success": true,
  "user": {
    "_id": "7w9BMr9r78W4RNe8x",
    "name": "John Smith",
    "username": "john.doe",
    "statusText": "On vacation",
    "active": true,
    "_updatedAt": "2026-06-24T10:05:00.000Z"
  }
}