Skip to main content

Заголовки запроса

string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
Требуется аутентификация и право SchoolManageUsers.

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

При обновлении все поля необязательны для заполнения. Если поле необходимо удалить и оно может быть пустым — передавайте null
string
Email адрес пользователя. Должен быть валидным email форматом. При передаче пустой строки — преобразуется в null.
string
Номер телефона пользователя. Должен быть в международном формате (например, +9876543210). При передаче пустой строки — преобразуется в null.
string
Доменный логин пользователя. До 65 символов: латинские буквы, цифры, _ и точки — точка не может быть первой/последней и не может идти подряд (автоматически приводится к нижнему регистру). Должен быть уникальным в рамках школы. Используется для входа наряду с email и phone.
integer
Telegram ID пользователя. Целое число или null. Логином не является — используется для связи аккаунта с Telegram.
string
Внешний идентификатор пользователя из вашей системы. Строка до 50 символов или null (пустая строка сбрасывает значение в null). Логином не является — используется только для связи с вашей CRM/LMS и поиска пользователя.
enum
Статус учётной записи: Active, OnLeave, Banned, Blocked или Terminated.
  • Active — обычный доступ;
  • OnLeave — «в отсутствии»: информационный статус, доступ не блокирует. Управляется автоматически модулем отсутствий — вручную устанавливать не рекомендуется;
  • Banned — забанен: вход запрещён, активные сессии завершаются. Чтобы снять бан — передайте Active: фактический статус пересчитается автоматически по трудоустройствам и отсутствиям (Terminated / OnLeave / Active), поэтому уволенный до бана сотрудник не получит доступ по ошибке;
  • Blocked — заблокирован: вход запрещён, активные сессии завершаются, зачисления на продукты блокируются. Возврат в Active восстанавливает доступ;
  • Terminated — уволен: доступ закрыт так же, как у Blocked. Управляется автоматически модулем трудоустройств (увольнение с последнего активного трудоустройства); при увольнении используйте staff/employment/terminate, а не прямую установку статуса.
Статус Deleted зарезервирован системой (удаление аккаунта) — передать его нельзя.
Булево поле banned из запроса удалено — блокировка управляется только через status (Banned / Blocked). В ответе поля banned и active по-прежнему присутствуют как производные от status.
Владелец школы защищён: другой администратор не может изменить его данные, а перевод владельца в блокирующий статус (Banned/Blocked/Terminated) запрещён даже для него самого — вернётся ошибка ForbiddenModifySchoolOwner.
object
Контейнер связанных данных — как в user/create: блок staff.employments (массив 1–10). Только для корпоративных школ; в отличие от создания — необязателен. Трудоустройства применяются идемпотентно: повторная передача той же активной пары департамент + должность не создаёт дубль.
Через extra в update можно только донанять сотрудника. Переводы, смена должности и увольнение — через эндпоинты раздела Сотрудники (HR).

Параметры профиля

object
Объект с данными профиля пользователя для обновления.
При обновлении пользователя можно изменить как основные данные, так и данные профиля. Если профиль не указан, то соответственно, он остается без изменений.

Обновление пользователя по внешнему идентификатору

Требуется аутентификация и право SchoolManageUsers.
То же самое, что и обновление по userId, но пользователь адресуется по внешнему идентификатору extId в рамках школы — удобно для интеграций (CRM/1С), где внутренние id Exode не хранятся. Тело запроса, ответ, защита владельца школы и поддержка extra — идентичны обычному update.

Параметры

string
required
Внешний идентификатор пользователя в рамках школы. Не может содержать / и пробельные символы; не-ASCII значения (кириллица и т.п.) в пути должны быть URL-encoded (encodeURIComponent).

Требования к правам доступа

Для обновления пользователя требуется право на управление пользователями школы.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.
При установке блокирующего статуса (Banned/Blocked/Terminated) все активные сессии пользователя автоматически завершаются — это реализовано для обеспечения безопасности.

Обновлено: 2026-07-22 12:24 UTC