Skip to main content

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

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

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

Поля для входа (логин)

Логином для входа в школу являются поля email, phone и domain — для автоматической отправки данных входа передайте хотя бы одно из них.
extId и tgId не являются логином — авторизоваться по ним нельзя. Они используются только как идентификаторы: extId — для связи с вашей CRM/LMS, tgId — для связи аккаунта с Telegram.
Логин и пароль для входа отправляется автоматически. Если не передать одно из полей ниже — то вам необходимо будет получить пароль и отправить его самостоятельно в настройках пользователя
Если передать поле password — пользователю будет установлен указанный пароль, а автоматическая генерация и отправка пароля выполняться не будет.
Для отправки логина и пароля в Telegram — пользователь должен дать разрешение писать боту или иметь активный чат с этим ботом
string
Email адрес пользователя. Должен быть валидным email форматом. При передаче пустой строки — преобразуется в null.
string
Номер телефона пользователя. Должен быть в международном формате (например, +9876543210). При передаче пустой строки — преобразуется в null.
string
Доменный логин пользователя. До 65 символов: латинские буквы, цифры, _ и точки — точка не может быть первой/последней и не может идти подряд (автоматически приводится к нижнему регистру). Должен быть уникальным в рамках школы. Чисто числовые значения и значения вида id12345 зарезервированы системой — задать их вручную нельзя (вернётся DomainIsBusy). Если не передан — генерируется автоматически в формате id12345. Удобен, когда логины формируются на вашей стороне и у пользователя нет email или телефона.

Идентификаторы для интеграции

string
Внешний идентификатор пользователя из вашей системы (например, GUID из CRM/1С). Строка до 50 символов без / и пробелов (используется в пути user/ext/{extId}/update) или null. При передаче пустой строки — преобразуется в null. Используется для связи и поиска пользователя (user/find, user/upsert), для входа не используется.
integer
Telegram ID пользователя. Целое число или null.

Дополнительные параметры

enum
Статус учётной записи: Active, OnLeave, Banned, Blocked или Terminated. По умолчанию Active.
  • Active — обычный доступ;
  • OnLeave — «в отсутствии» (отпуск, больничный и т.п.): информационный статус, вход и доступ не блокирует. Управляется автоматически модулем отсутствий;
  • Banned — забанен: вход запрещён, активные сессии завершаются. При снятии бана фактический статус пересчитывается автоматически (по трудоустройствам и отсутствиям);
  • Blocked — заблокирован администратором: вход запрещён, активные сессии завершаются, зачисления на продукты блокируются. Пользователь остаётся видимым в отчётах; возврат в Active восстанавливает доступ;
  • Terminated — уволен: доступ закрыт так же, как у Blocked. Ставится автоматически при увольнении с последнего активного трудоустройства; повторный найм возвращает Active.
Статус Deleted зарезервирован системой (удаление аккаунта) — передать его нельзя.
Булево поле banned из запроса удалено — блокировка управляется только через status (Banned / Blocked). В ответе поля banned и active по-прежнему присутствуют как производные от status.
string
Пароль пользователя. От 6 до 100 символов. Если передан — устанавливается как пароль для входа, автоматическая отправка сгенерированного пароля пропускается. При передаче пустой строки — преобразуется в null. Доступно только при создании (в update поле не поддерживается).

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

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

Дополнительные агрегаты (extra)

object
Контейнер связанных данных, применяемых вместе с созданием пользователя. Сейчас содержит блок staff (трудоустройства); в будущем будет расширяться другими агрегатами.
Данные, которых нет в этой схеме (город, произвольный статус из CRM и т.п.), передаются через кастомные поля. Управление департаментами, должностями и трудоустройствами после создания — в разделе Сотрудники (HR).

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

Для создания пользователя требуется право на управление пользователями школы.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

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