Установка активного статуса

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

POST /users.setActiveStatus

Описание

Устанавливает активный статус пользователя (активен/неактивен).

Параметры

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

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор пользователя
activeStatus	да	boolean	Активность пользователя: true или false

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.setActiveStatus' \
  -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>",
  "activeStatus": true
  }'

Где:

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

Ответ

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

{
  "success": true
}