Create a user

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "phone": "+9876543210",
    "domain": "i_ivanov",
    "extId": "crm_12345",
    "tgId": null,
    "password": "SecurePass123",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname",
      "bdate": "1990-01-01",
      "sex": "Men",
      "role": "Student"
    }
  }'

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "domain": "i_ivanov",
    "extId": "guid-1c-4f2a",
    "status": "Active",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname"
    },
    "extra": {
      "staff": {
        "employments": [
          {
            "extId": "emp-1c-0042",
            "positionExtId": "pos_manager",
            "departmentExtId": "dep_sales",
            "kind": "Main",
            "type": "FullTime",
            "startAt": "2026-07-01T00:00:00Z",
            "rate": 1
          }
        ]
      }
    }
  }'

const axios = require('axios');

const createUser = async () => {
  try {
    const response = await axios.post('https://api.exode.biz/saas/v2/user/create', {
      email: '[email protected]',
      phone: '+9876543210',
      domain: 'i_ivanov',
      extId: 'crm_12345',
      tgId: null,
      password: 'SecurePass123',
      profile: {
        firstName: 'Firstname',
        lastName: 'Lastname',
        bdate: '1990-01-01',
        sex: 'Men',
        role: 'Student'
      }
    }, {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User created:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

createUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/create';
$data = [
  'email' => '[email protected]',
  'phone' => '+9876543210',
  'domain' => 'i_ivanov',
  'extId' => 'crm_12345',
  'tgId' => null,
  'password' => 'SecurePass123',
  'profile' => [
    'firstName' => 'Firstname',
    'lastName' => 'Lastname',
    'bdate' => '1990-01-01',
    'sex' => 'Men',
    'role' => 'Student'
  ]
];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Content-Type: application/json',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 201) {
  $result = json_decode($response, true);
  echo "User created successfully\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/create'

data = {
  'email': '[email protected]',
  'phone': '+9876543210',
  'domain': 'i_ivanov',
  'extId': 'crm_12345',
  'tgId': None,
  'password': 'SecurePass123',
  'profile': {
    'firstName': 'Firstname',
    'lastName': 'Lastname',
    'bdate': '1990-01-01',
    'sex': 'Men',
    'role': 'Student'
  }
}

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.post(url, json=data, headers=headers)
  response.raise_for_status()

  result = response.json()
  print('User created successfully:')
  print(json.dumps(result['payload'], indent=2, ensure_ascii=False))

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Профиль = Новый Структура;
Профиль.Вставить("firstName", "Firstname");
Профиль.Вставить("lastName", "Lastname");
Профиль.Вставить("bdate", "1990-01-01");
Профиль.Вставить("sex", "Men");
Профиль.Вставить("role", "Student");

Данные = Новый Структура;
Данные.Вставить("email", "[email protected]");
Данные.Вставить("phone", "+9876543210");
Данные.Вставить("domain", "i_ivanov");
Данные.Вставить("extId", "crm_12345");
Данные.Вставить("tgId", Неопределено);
Данные.Вставить("password", "SecurePass123");
Данные.Вставить("profile", Профиль);

// Serialize body to JSON
ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Данные);
ТелоЗапроса = ЗаписьJSON.Закрыть();

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/create");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Content-Type", "application/json");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

Ответ = Соединение.ВызватьHTTPМетод("POST", Запрос);

Если Ответ.КодСостояния = 201 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User created");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "success": true,
  "code": 201,
  "payload": {
    "user": {
      "id": 1683,
      "createdAt": "2026-07-02T11:15:46.896Z",
      "updatedAt": "2026-07-02T11:15:46.940Z",
      "archivedAt": null,
      "uuid": "e-cjTT0CWMCB",
      "active": true,
      "activated": true,
      "banned": false,
      "status": "Active",
      "alive": true,
      "domain": "i_ivanov",
      "email": "[email protected]",
      "phone": "+9876543210",
      "tgId": null,
      "vkId": null,
      "appleId": null,
      "extId": "crm_12345",
      "schoolId": 198,
      "language": null,
      "timezone": null,
      "lastOnlineAt": null,
      "starsBalance": 0,
      "currentTime": "2026-07-02T11:15:46+00:00",
      "isSleepingNow": false,
      "profile": {
        "id": 1665,
        "createdAt": "2026-07-02T11:15:46.932Z",
        "updatedAt": "2026-07-02T11:15:46.932Z",
        "archivedAt": null,
        "userId": 1683,
        "official": false,
        "firstName": "Firstname",
        "lastName": "Lastname",
        "fullName": "Firstname Lastname",
        "fullNameShort": "Firstname L.",
        "bdate": "1990-01-01",
        "sex": "Men",
        "country": null,
        "city": null,
        "role": "Student",
        "status": null,
        "title": "",
        "emojiTitle": "",
        "avatar": {
          "id": 1665,
          "small": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/small/avatar.png",
          "medium": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/medium/avatar.png",
          "maximum": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/avatar.png"
        },
        "titleState": {
          "manualTitle": null,
          "manualEmojiTitle": null,
          "manualNextTitle": null,
          "manualNextEmojiTitle": null,
          "manualExpiredAt": null,
          "locationTitle": null,
          "locationEmojiTitle": null,
          "achievementTitle": null,
          "achievementEmojiTitle": null
        }
      }
    }
  }
}

{
  "code": 400,
  "success": false,
  "cause": "EmailIsBusy",
  "message": "Email is busy",
  "error": "Email is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "PhoneIsBusy",
  "message": "Phone is busy",
  "error": "Phone is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "TgIdIsBusy",
  "message": "Tg id is busy",
  "error": "Tg id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "ExtIdIsBusy",
  "message": "Ext id is busy",
  "error": "Ext id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsBusy",
  "message": "This domain is already taken",
  "error": "This domain is already taken"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsInvalid",
  "message": "Domain is invalid",
  "error": "Domain is invalid"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "phone must be a valid phone number"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "profile.firstName must be shorter than or equal to 15 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffEmploymentInputRequired",
  "message": "Staff employment input is required for Corporate school user",
  "error": "Staff employment input is required for Corporate school user"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffOnlyForCorporateSchool",
  "message": "Staff is available only for Corporate school",
  "error": "Staff is available only for Corporate school"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Department not found",
  "error": "Department not found"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffPositionNotFound",
  "message": "Position not found",
  "error": "Position not found"
}

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "phone": "+9876543210",
    "domain": "i_ivanov",
    "extId": "crm_12345",
    "tgId": null,
    "password": "SecurePass123",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname",
      "bdate": "1990-01-01",
      "sex": "Men",
      "role": "Student"
    }
  }'

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "domain": "i_ivanov",
    "extId": "guid-1c-4f2a",
    "status": "Active",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname"
    },
    "extra": {
      "staff": {
        "employments": [
          {
            "extId": "emp-1c-0042",
            "positionExtId": "pos_manager",
            "departmentExtId": "dep_sales",
            "kind": "Main",
            "type": "FullTime",
            "startAt": "2026-07-01T00:00:00Z",
            "rate": 1
          }
        ]
      }
    }
  }'

const axios = require('axios');

const createUser = async () => {
  try {
    const response = await axios.post('https://api.exode.biz/saas/v2/user/create', {
      email: '[email protected]',
      phone: '+9876543210',
      domain: 'i_ivanov',
      extId: 'crm_12345',
      tgId: null,
      password: 'SecurePass123',
      profile: {
        firstName: 'Firstname',
        lastName: 'Lastname',
        bdate: '1990-01-01',
        sex: 'Men',
        role: 'Student'
      }
    }, {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User created:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

createUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/create';
$data = [
  'email' => '[email protected]',
  'phone' => '+9876543210',
  'domain' => 'i_ivanov',
  'extId' => 'crm_12345',
  'tgId' => null,
  'password' => 'SecurePass123',
  'profile' => [
    'firstName' => 'Firstname',
    'lastName' => 'Lastname',
    'bdate' => '1990-01-01',
    'sex' => 'Men',
    'role' => 'Student'
  ]
];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Content-Type: application/json',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 201) {
  $result = json_decode($response, true);
  echo "User created successfully\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/create'

data = {
  'email': '[email protected]',
  'phone': '+9876543210',
  'domain': 'i_ivanov',
  'extId': 'crm_12345',
  'tgId': None,
  'password': 'SecurePass123',
  'profile': {
    'firstName': 'Firstname',
    'lastName': 'Lastname',
    'bdate': '1990-01-01',
    'sex': 'Men',
    'role': 'Student'
  }
}

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.post(url, json=data, headers=headers)
  response.raise_for_status()

  result = response.json()
  print('User created successfully:')
  print(json.dumps(result['payload'], indent=2, ensure_ascii=False))

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Профиль = Новый Структура;
Профиль.Вставить("firstName", "Firstname");
Профиль.Вставить("lastName", "Lastname");
Профиль.Вставить("bdate", "1990-01-01");
Профиль.Вставить("sex", "Men");
Профиль.Вставить("role", "Student");

Данные = Новый Структура;
Данные.Вставить("email", "[email protected]");
Данные.Вставить("phone", "+9876543210");
Данные.Вставить("domain", "i_ivanov");
Данные.Вставить("extId", "crm_12345");
Данные.Вставить("tgId", Неопределено);
Данные.Вставить("password", "SecurePass123");
Данные.Вставить("profile", Профиль);

// Serialize body to JSON
ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Данные);
ТелоЗапроса = ЗаписьJSON.Закрыть();

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/create");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Content-Type", "application/json");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

Ответ = Соединение.ВызватьHTTPМетод("POST", Запрос);

Если Ответ.КодСостояния = 201 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User created");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "success": true,
  "code": 201,
  "payload": {
    "user": {
      "id": 1683,
      "createdAt": "2026-07-02T11:15:46.896Z",
      "updatedAt": "2026-07-02T11:15:46.940Z",
      "archivedAt": null,
      "uuid": "e-cjTT0CWMCB",
      "active": true,
      "activated": true,
      "banned": false,
      "status": "Active",
      "alive": true,
      "domain": "i_ivanov",
      "email": "[email protected]",
      "phone": "+9876543210",
      "tgId": null,
      "vkId": null,
      "appleId": null,
      "extId": "crm_12345",
      "schoolId": 198,
      "language": null,
      "timezone": null,
      "lastOnlineAt": null,
      "starsBalance": 0,
      "currentTime": "2026-07-02T11:15:46+00:00",
      "isSleepingNow": false,
      "profile": {
        "id": 1665,
        "createdAt": "2026-07-02T11:15:46.932Z",
        "updatedAt": "2026-07-02T11:15:46.932Z",
        "archivedAt": null,
        "userId": 1683,
        "official": false,
        "firstName": "Firstname",
        "lastName": "Lastname",
        "fullName": "Firstname Lastname",
        "fullNameShort": "Firstname L.",
        "bdate": "1990-01-01",
        "sex": "Men",
        "country": null,
        "city": null,
        "role": "Student",
        "status": null,
        "title": "",
        "emojiTitle": "",
        "avatar": {
          "id": 1665,
          "small": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/small/avatar.png",
          "medium": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/medium/avatar.png",
          "maximum": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/avatar.png"
        },
        "titleState": {
          "manualTitle": null,
          "manualEmojiTitle": null,
          "manualNextTitle": null,
          "manualNextEmojiTitle": null,
          "manualExpiredAt": null,
          "locationTitle": null,
          "locationEmojiTitle": null,
          "achievementTitle": null,
          "achievementEmojiTitle": null
        }
      }
    }
  }
}

{
  "code": 400,
  "success": false,
  "cause": "EmailIsBusy",
  "message": "Email is busy",
  "error": "Email is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "PhoneIsBusy",
  "message": "Phone is busy",
  "error": "Phone is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "TgIdIsBusy",
  "message": "Tg id is busy",
  "error": "Tg id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "ExtIdIsBusy",
  "message": "Ext id is busy",
  "error": "Ext id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsBusy",
  "message": "This domain is already taken",
  "error": "This domain is already taken"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsInvalid",
  "message": "Domain is invalid",
  "error": "Domain is invalid"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "phone must be a valid phone number"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "profile.firstName must be shorter than or equal to 15 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffEmploymentInputRequired",
  "message": "Staff employment input is required for Corporate school user",
  "error": "Staff employment input is required for Corporate school user"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffOnlyForCorporateSchool",
  "message": "Staff is available only for Corporate school",
  "error": "Staff is available only for Corporate school"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Department not found",
  "error": "Department not found"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffPositionNotFound",
  "message": "Position not found",
  "error": "Position not found"
}

Request headers

string

required

The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.

integer

required

The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.

integer

required

The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.

POST /saas/v2/user/create

Requires authentication and the “School User Management” permission (SchoolManageUsers).

Request parameters

The fields email, phone and domain serve as the login for signing in to the school. To have the sign-in credentials sent automatically, pass at least one of them.

extId and tgId are not logins — you cannot sign in with them. They are used only as identifiers: extId links the user to your CRM/LMS, tgId links the account to Telegram.

The login and password are sent to the user automatically (a few seconds after creation): by SMS if phone is passed and an SMS provider is connected in the school for that phone’s country, otherwise to email; additionally to Telegram if tgId is passed. If no channel is available (for example, only domain is passed, or a phone without a connected SMS provider), get the password from the user’s settings in the account and deliver it yourself.

If you pass the password field, the user gets the specified password instead of a generated one. The sign-in credentials are still sent through the channels above — with your password.

To receive the login and password in Telegram, the user must allow the bot to message them or have an active chat with that bot.

create or upsert? create always creates a new user and returns an error (EmailIsBusy, PhoneIsBusy, ExtIdIsBusy, etc.) if the login or identifier is already taken. If, when syncing from your system, you don’t know whether the user already exists in the school, use user/upsert — it finds the existing user and updates it.

string

The user’s email address. Must be a valid email. An empty string is converted to null.

string

The user’s phone number. Must be in international format (for example, +9876543210). An empty string is converted to null.

string

The user’s domain login. Up to 65 characters: Latin letters, digits, _ and dots — a dot cannot be first/last and dots cannot be consecutive (automatically converted to lower case). Must be unique within the school. Purely numeric values and values like id12345 are reserved by the system and cannot be set manually (DomainIsBusy is returned). If not passed, it is generated automatically in the id12345 format. Useful when logins are generated on your side and the user has no email or phone.

Integration identifiers

string

The user’s external identifier from your system (for example, a GUID from your CRM/1C). A string of up to 50 characters without / or spaces (it is used in the user/ext/{extId}/update path), or null. An empty string is converted to null. Used to link and look up the user (user/find, user/upsert); not used for signing in.

integer

The user’s Telegram ID. An integer or null.

Additional parameters

enum

Account status: Active, OnLeave, Banned, Blocked or Terminated. Defaults to Active.

Active — regular access;
OnLeave — “absent” (vacation, sick leave, etc.): an informational status that does not block sign-in or access. Managed automatically by the absences module;
Banned — banned: sign-in is denied and active sessions are terminated. When the ban is lifted, the effective status is recalculated automatically (based on employments and absences);
Blocked — blocked by an administrator: sign-in is denied, active sessions are terminated, and product enrollments are blocked. The user remains visible in reports; switching back to Active restores access;
Terminated — dismissed: access is closed the same way as for Blocked. Set automatically on termination of the last active employment; rehiring returns Active.

The Deleted status is reserved by the system (account deletion) and cannot be passed.

The boolean banned field has been removed from the request — blocking is managed only through status (Banned / Blocked). The banned and active fields are still present in the response, derived from status.

string

The user’s password. From 6 to 100 characters. If passed, it is set as the sign-in password instead of a generated one (the credentials are still sent to the user, see above). An empty string is converted to null. Available only on creation (the field is not supported in update and upsert).

Profile parameters

object

An object with the user’s profile data.

Show Profile properties

string

The user’s first name. Up to 15 characters: letters (Latin and Cyrillic, including ў/ғ/қ/ҳ), spaces and apostrophes (for example, O'Brien). Leading and trailing spaces are trimmed automatically.

string

The user’s last name. Up to 15 characters: letters (Latin and Cyrillic, including ў/ғ/қ/ҳ), spaces and apostrophes (for example, O'Brien). Leading and trailing spaces are trimmed automatically.

string

Date of birth in YYYY-MM-DD format.

enum

The user’s sex. Possible values: Ufo, Women, Men.

enum

The user’s role. Possible values: Student, Tutor, Parent.

When a user is created, a linked profile with the specified data is created automatically. If no profile is passed, an empty profile is created, and the user fills in firstName and lastName on first sign-in.

Additional aggregates (`extra`)

object

A container for related data applied together with user creation. It currently contains the staff block (employments); other aggregates will be added in the future.

Show extra properties

object

Employment data for the employee being created. Available only for corporate schools, where the block is required — an employee cannot exist without an employment.

Show staff properties

array

required

An array of employments (from 1 to 10). Multiple items mean concurrent employment: for example, a main job plus an internal secondary job in another department.A department is required in each item and is specified via departmentId or departmentExtId. A position is optional: you can set it via positionId or positionExtId, or omit it entirely — then the employee is hired without a position (external identifiers come from your system, see Positions and Departments).

Show employments item properties

string

The employment’s external identifier from your system. From 1 to 50 characters, without / or spaces. Unique within the school among open employments.

integer

The position ID in Exode. Optional. Specify it via positionId or positionExtId (not both at once), or omit it entirely — then the employee is hired without a position.

string

The position’s external identifier from your system. From 1 to 50 characters. Optional — an alternative to positionId (pass at most one field of the pair).

integer

The department ID in Exode. Required if departmentExtId is not passed.

string

The department’s external identifier from your system. From 1 to 50 characters. Required if departmentId is not passed.

enum

Employment kind: Main (main job), InternalSecondary (internal secondary job), ExternalSecondary (external secondary job). Defaults to Main.

enum

Employment type: FullTime or PartTime. Defaults to FullTime.

string

Employment start date in ISO 8601 format. Defaults to the current moment.

number

Rate — a fraction of a full-time rate, from 0.01 to 1. Defaults to 1.

Data not covered by this schema (city, a custom status from your CRM, etc.) is passed via custom fields. Departments, positions and employments are managed after creation in the Staff (HR) section.

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "phone": "+9876543210",
    "domain": "i_ivanov",
    "extId": "crm_12345",
    "tgId": null,
    "password": "SecurePass123",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname",
      "bdate": "1990-01-01",
      "sex": "Men",
      "role": "Student"
    }
  }'

curl --location 'https://api.exode.biz/saas/v2/user/create' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "email": "[email protected]",
    "domain": "i_ivanov",
    "extId": "guid-1c-4f2a",
    "status": "Active",
    "profile": {
      "firstName": "Firstname",
      "lastName": "Lastname"
    },
    "extra": {
      "staff": {
        "employments": [
          {
            "extId": "emp-1c-0042",
            "positionExtId": "pos_manager",
            "departmentExtId": "dep_sales",
            "kind": "Main",
            "type": "FullTime",
            "startAt": "2026-07-01T00:00:00Z",
            "rate": 1
          }
        ]
      }
    }
  }'

const axios = require('axios');

const createUser = async () => {
  try {
    const response = await axios.post('https://api.exode.biz/saas/v2/user/create', {
      email: '[email protected]',
      phone: '+9876543210',
      domain: 'i_ivanov',
      extId: 'crm_12345',
      tgId: null,
      password: 'SecurePass123',
      profile: {
        firstName: 'Firstname',
        lastName: 'Lastname',
        bdate: '1990-01-01',
        sex: 'Men',
        role: 'Student'
      }
    }, {
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    });

    console.log('User created:', response.data.payload);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

createUser();

<?php

$url = 'https://api.exode.biz/saas/v2/user/create';
$data = [
  'email' => '[email protected]',
  'phone' => '+9876543210',
  'domain' => 'i_ivanov',
  'extId' => 'crm_12345',
  'tgId' => null,
  'password' => 'SecurePass123',
  'profile' => [
    'firstName' => 'Firstname',
    'lastName' => 'Lastname',
    'bdate' => '1990-01-01',
    'sex' => 'Men',
    'role' => 'Student'
  ]
];

$headers = [
  'Seller-Id: {{ sellerId }}',
  'School-Id: {{ schoolId }}',
  'Content-Type: application/json',
  'Authorization: Bearer YOUR_TOKEN'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 201) {
  $result = json_decode($response, true);
  echo "User created successfully\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/user/create'

data = {
  'email': '[email protected]',
  'phone': '+9876543210',
  'domain': 'i_ivanov',
  'extId': 'crm_12345',
  'tgId': None,
  'password': 'SecurePass123',
  'profile': {
    'firstName': 'Firstname',
    'lastName': 'Lastname',
    'bdate': '1990-01-01',
    'sex': 'Men',
    'role': 'Student'
  }
}

headers = {
  'Seller-Id': '{{ sellerId }}',
  'School-Id': '{{ schoolId }}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer YOUR_TOKEN'
}

try:
  response = requests.post(url, json=data, headers=headers)
  response.raise_for_status()

  result = response.json()
  print('User created successfully:')
  print(json.dumps(result['payload'], indent=2, ensure_ascii=False))

except requests.exceptions.RequestException as e:
  print(f'Error: {e}')
  if hasattr(e, 'response') and e.response is not None:
    print(f'Response: {e.response.text}')

Профиль = Новый Структура;
Профиль.Вставить("firstName", "Firstname");
Профиль.Вставить("lastName", "Lastname");
Профиль.Вставить("bdate", "1990-01-01");
Профиль.Вставить("sex", "Men");
Профиль.Вставить("role", "Student");

Данные = Новый Структура;
Данные.Вставить("email", "[email protected]");
Данные.Вставить("phone", "+9876543210");
Данные.Вставить("domain", "i_ivanov");
Данные.Вставить("extId", "crm_12345");
Данные.Вставить("tgId", Неопределено);
Данные.Вставить("password", "SecurePass123");
Данные.Вставить("profile", Профиль);

// Serialize body to JSON
ЗаписьJSON = Новый ЗаписьJSON;
ЗаписьJSON.УстановитьСтроку();
ЗаписатьJSON(ЗаписьJSON, Данные);
ТелоЗапроса = ЗаписьJSON.Закрыть();

Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

Запрос = Новый HTTPЗапрос("/saas/v2/user/create");
Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
Запрос.Заголовки.Вставить("Content-Type", "application/json");
Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

Ответ = Соединение.ВызватьHTTPМетод("POST", Запрос);

Если Ответ.КодСостояния = 201 Тогда
    ЧтениеJSON = Новый ЧтениеJSON;
    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
    Результат = ПрочитатьJSON(ЧтениеJSON);
    Сообщить("User created");
Иначе
    Сообщить("Error: HTTP " + Ответ.КодСостояния);
    Сообщить(Ответ.ПолучитьТелоКакСтроку());
КонецЕсли;

{
  "success": true,
  "code": 201,
  "payload": {
    "user": {
      "id": 1683,
      "createdAt": "2026-07-02T11:15:46.896Z",
      "updatedAt": "2026-07-02T11:15:46.940Z",
      "archivedAt": null,
      "uuid": "e-cjTT0CWMCB",
      "active": true,
      "activated": true,
      "banned": false,
      "status": "Active",
      "alive": true,
      "domain": "i_ivanov",
      "email": "[email protected]",
      "phone": "+9876543210",
      "tgId": null,
      "vkId": null,
      "appleId": null,
      "extId": "crm_12345",
      "schoolId": 198,
      "language": null,
      "timezone": null,
      "lastOnlineAt": null,
      "starsBalance": 0,
      "currentTime": "2026-07-02T11:15:46+00:00",
      "isSleepingNow": false,
      "profile": {
        "id": 1665,
        "createdAt": "2026-07-02T11:15:46.932Z",
        "updatedAt": "2026-07-02T11:15:46.932Z",
        "archivedAt": null,
        "userId": 1683,
        "official": false,
        "firstName": "Firstname",
        "lastName": "Lastname",
        "fullName": "Firstname Lastname",
        "fullNameShort": "Firstname L.",
        "bdate": "1990-01-01",
        "sex": "Men",
        "country": null,
        "city": null,
        "role": "Student",
        "status": null,
        "title": "",
        "emojiTitle": "",
        "avatar": {
          "id": 1665,
          "small": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/small/avatar.png",
          "medium": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/medium/avatar.png",
          "maximum": "https://storage.exode.biz/production/user/1683/xK2mVwNib9b0/avatar.png"
        },
        "titleState": {
          "manualTitle": null,
          "manualEmojiTitle": null,
          "manualNextTitle": null,
          "manualNextEmojiTitle": null,
          "manualExpiredAt": null,
          "locationTitle": null,
          "locationEmojiTitle": null,
          "achievementTitle": null,
          "achievementEmojiTitle": null
        }
      }
    }
  }
}

{
  "code": 400,
  "success": false,
  "cause": "EmailIsBusy",
  "message": "Email is busy",
  "error": "Email is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "PhoneIsBusy",
  "message": "Phone is busy",
  "error": "Phone is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "TgIdIsBusy",
  "message": "Tg id is busy",
  "error": "Tg id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "ExtIdIsBusy",
  "message": "Ext id is busy",
  "error": "Ext id is busy"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsBusy",
  "message": "This domain is already taken",
  "error": "This domain is already taken"
}

{
  "code": 400,
  "success": false,
  "cause": "DomainIsInvalid",
  "message": "Domain is invalid",
  "error": "Domain is invalid"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "phone must be a valid phone number"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": [
    "profile.firstName must be shorter than or equal to 15 characters"
  ],
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffEmploymentInputRequired",
  "message": "Staff employment input is required for Corporate school user",
  "error": "Staff employment input is required for Corporate school user"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffOnlyForCorporateSchool",
  "message": "Staff is available only for Corporate school",
  "error": "Staff is available only for Corporate school"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffDepartmentNotFound",
  "message": "Department not found",
  "error": "Department not found"
}

{
  "code": 400,
  "success": false,
  "cause": "StaffPositionNotFound",
  "message": "Position not found",
  "error": "Position not found"
}

Permission requirements

Creating a user requires the “School User Management” permission (SchoolManageUsers).

The service user must be authenticated with a token and have the appropriate access permissions for the specified school.

Updated: 2026-09-25 14:33 UTC

Working with the API

Users

Staff (HR)

Groups

Courses

Access and sales

Reports and exports

Custom fields

Forms

Missing a method?

All objects

Request headers

Request parameters

Integration identifiers

Additional parameters

Profile parameters

Additional aggregates (`extra`)

Permission requirements

​Request headers

​Request parameters

​Sign-in fields (login)

​Integration identifiers

​Additional parameters

​Profile parameters

​Additional aggregates (extra)

​Permission requirements

Request headers

Request parameters

Sign-in fields (login)

Integration identifiers

Additional parameters

Profile parameters

Additional aggregates (`extra`)

Permission requirements