Add members

curl --location --request POST 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "userIds": [8, 15, 23]
  }'

const axios = require('axios');

const addMembersToGroup = async () => {
  try {
    const response = await axios.post(
      'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many',
      {
        userIds: [8, 15, 23]
      },
      {
        headers: {
          'Seller-Id': '{{ sellerId }}',
          'School-Id': '{{ schoolId }}',
          'Content-Type': 'application/json',
          'Authorization': 'Bearer YOUR_TOKEN'
        }
      }
    );

    console.log('Members added:', response.data.payload.created);
    console.log('Existing members:', response.data.payload.exist);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

addMembersToGroup();

<?php

$url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many';
$data = [
  'userIds' => [8, 15, 23]
];

$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 "Members added successfully\n";
  echo "Created: " . count($result['payload']['created']) . "\n";
  echo "Existing: " . count($result['payload']['exist']) . "\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many'

data = {
  'userIds': [8, 15, 23]
}

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('Members added successfully:')
  print(f"Created: {len(result['payload']['created'])}")
  print(f"Existing: {len(result['payload']['exist'])}")
  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}')

ИдентификаторыПользователей = Новый Массив;
ИдентификаторыПользователей.Добавить(8);
ИдентификаторыПользователей.Добавить(15);
ИдентификаторыПользователей.Добавить(23);

Данные = Новый Структура;
Данные.Вставить("userIds", ИдентификаторыПользователей);

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

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

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

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

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

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [],
    "created": [
      {
        "id": 1227,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 15,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 15,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id15",
          "email": "[email protected]",
          "phone": "+987654321",
          "extId": "crm_12345",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 0
        }
      }
    ],
    "excluded": []
  }
}

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [
      {
        "id": 1226,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 8,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 8,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id8",
          "email": "[email protected]",
          "phone": null,
          "extId": "crm_54321",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 12
        }
      }
    ],
    "created": [],
    "excluded": []
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - seller not entity owner",
  "error": "Forbidden seller resource - seller not entity owner"
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - permissions SchoolManageUsers",
  "error": "Forbidden seller resource - permissions SchoolManageUsers"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "Max length is 250 elements",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "ids must be an array",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "GroupNotBoundToProduct",
  "message": "Group not tied to product",
  "error": "Group not tied to product"
}

curl --location --request POST 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "userIds": [8, 15, 23]
  }'

const axios = require('axios');

const addMembersToGroup = async () => {
  try {
    const response = await axios.post(
      'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many',
      {
        userIds: [8, 15, 23]
      },
      {
        headers: {
          'Seller-Id': '{{ sellerId }}',
          'School-Id': '{{ schoolId }}',
          'Content-Type': 'application/json',
          'Authorization': 'Bearer YOUR_TOKEN'
        }
      }
    );

    console.log('Members added:', response.data.payload.created);
    console.log('Existing members:', response.data.payload.exist);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

addMembersToGroup();

<?php

$url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many';
$data = [
  'userIds' => [8, 15, 23]
];

$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 "Members added successfully\n";
  echo "Created: " . count($result['payload']['created']) . "\n";
  echo "Existing: " . count($result['payload']['exist']) . "\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many'

data = {
  'userIds': [8, 15, 23]
}

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('Members added successfully:')
  print(f"Created: {len(result['payload']['created'])}")
  print(f"Existing: {len(result['payload']['exist'])}")
  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}')

ИдентификаторыПользователей = Новый Массив;
ИдентификаторыПользователей.Добавить(8);
ИдентификаторыПользователей.Добавить(15);
ИдентификаторыПользователей.Добавить(23);

Данные = Новый Структура;
Данные.Вставить("userIds", ИдентификаторыПользователей);

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

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

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

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

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

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [],
    "created": [
      {
        "id": 1227,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 15,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 15,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id15",
          "email": "[email protected]",
          "phone": "+987654321",
          "extId": "crm_12345",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 0
        }
      }
    ],
    "excluded": []
  }
}

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [
      {
        "id": 1226,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 8,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 8,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id8",
          "email": "[email protected]",
          "phone": null,
          "extId": "crm_54321",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 12
        }
      }
    ],
    "created": [],
    "excluded": []
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - seller not entity owner",
  "error": "Forbidden seller resource - seller not entity owner"
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - permissions SchoolManageUsers",
  "error": "Forbidden seller resource - permissions SchoolManageUsers"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "Max length is 250 elements",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "ids must be an array",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "GroupNotBoundToProduct",
  "message": "Group not tied to product",
  "error": "Group not tied to product"
}

This operation adds multiple users to a group at once. If a user is already a member of the group, they are not added again.

When users are added to a group, the related member and access records are created automatically. If a user is already a member of the group, they are not added again.

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/group/:groupId/member/create-many

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

Request parameters

The maximum number of users you can add in a single request is 250. To add more users, use several requests.

integer

required

Group ID — the groupId field from the group list. To enroll a user in a course, find that course’s group with the courseIds filter (see Course enrollment). The group must be bound to a product, otherwise the GroupNotBoundToProduct error is returned.

integer[]

required

An array of numeric user IDs in Exode (the id field from user/find or user/list). Up to 250 users per request.

If a user is already a member of the group, they are not added again. The response shows which users already exist in the group and which were added. IDs not found in the school from the School-Id header are silently skipped and appear in neither exist nor created — reconcile the response with the request. Repeating the call with the same userIds is safe.

For each new member, access to the group’s product is granted (or reactivated if it was disabled), and the ProductEnrolledViaLms webhook is sent. For users in exist, access and webhooks are not affected.

curl --location --request POST 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data-raw '{
    "userIds": [8, 15, 23]
  }'

const axios = require('axios');

const addMembersToGroup = async () => {
  try {
    const response = await axios.post(
      'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many',
      {
        userIds: [8, 15, 23]
      },
      {
        headers: {
          'Seller-Id': '{{ sellerId }}',
          'School-Id': '{{ schoolId }}',
          'Content-Type': 'application/json',
          'Authorization': 'Bearer YOUR_TOKEN'
        }
      }
    );

    console.log('Members added:', response.data.payload.created);
    console.log('Existing members:', response.data.payload.exist);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

addMembersToGroup();

<?php

$url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many';
$data = [
  'userIds' => [8, 15, 23]
];

$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 "Members added successfully\n";
  echo "Created: " . count($result['payload']['created']) . "\n";
  echo "Existing: " . count($result['payload']['exist']) . "\n";
  print_r($result['payload']);
} else {
  echo "Error: HTTP $httpCode\n";
  echo $response;
}
?>

import requests
import json

url = 'https://api.exode.biz/saas/v2/group/{{ groupId }}/member/create-many'

data = {
  'userIds': [8, 15, 23]
}

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('Members added successfully:')
  print(f"Created: {len(result['payload']['created'])}")
  print(f"Existing: {len(result['payload']['exist'])}")
  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}')

ИдентификаторыПользователей = Новый Массив;
ИдентификаторыПользователей.Добавить(8);
ИдентификаторыПользователей.Добавить(15);
ИдентификаторыПользователей.Добавить(23);

Данные = Новый Структура;
Данные.Вставить("userIds", ИдентификаторыПользователей);

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

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

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

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

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

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [],
    "created": [
      {
        "id": 1227,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 15,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 15,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id15",
          "email": "[email protected]",
          "phone": "+987654321",
          "extId": "crm_12345",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 0
        }
      }
    ],
    "excluded": []
  }
}

{
  "success": true,
  "code": 201,
  "payload": {
    "exist": [
      {
        "id": 1226,
        "createdAt": "2025-07-19T15:45:51.212Z",
        "updatedAt": "2025-07-19T15:45:51.212Z",
        "groupId": 501,
        "userId": 8,
        "inviterId": 42,
        "active": true,
        "blockedUntil": null,
        "isAddedToTg": false,
        "user": {
          "id": 8,
          "uuid": "YRnh3REH1Wbd",
          "status": "Active",
          "active": true,
          "activated": true,
          "banned": false,
          "domain": "id8",
          "email": "[email protected]",
          "phone": null,
          "extId": "crm_54321",
          "language": "Ru",
          "timezone": 5,
          "lastOnlineAt": "2025-07-20T19:14:03.972Z",
          "starsBalance": 12
        }
      }
    ],
    "created": [],
    "excluded": []
  }
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - seller not entity owner",
  "error": "Forbidden seller resource - seller not entity owner"
}

{
  "code": 401,
  "success": false,
  "cause": "Forbidden",
  "message": "Forbidden seller resource - permissions SchoolManageUsers",
  "error": "Forbidden seller resource - permissions SchoolManageUsers"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "Max length is 250 elements",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "validation",
  "message": "ids must be an array",
  "error": "Bad Request"
}

{
  "code": 400,
  "success": false,
  "cause": "GroupNotBoundToProduct",
  "message": "Group not tied to product",
  "error": "Group not tied to product"
}

Response parameters

array

An array of users who are already members of the group.

Show Member properties

integer

required

Unique identifier of the group member.

timestamp

required

Date and time the member record was created.

timestamp

required

Date and time the member record was last updated.

integer | null

Group ID.

integer | null

User ID.

integer | null

ID of the user who added the member.

boolean

required

Whether the member is active in the group.

timestamp | null

Date until which the member is blocked (if applicable).

boolean | null

Whether the member has been added to the group’s Telegram chat/channel.

object

User object.

Show User properties

integer

required

Unique identifier of the user.

string

required

User UUID.

enum

User status: Active, OnLeave, Banned, Blocked, Terminated, Deleted.

boolean

Not deleted (derived from status).

boolean

Whether the user has confirmed sign-in.

boolean

Banned or deleted (derived from status).

string

The user’s registration domain.

string | null

The user’s email address.

string | null

The user’s phone number.

string | null

The user’s external identifier.

enum | null

The user’s interface language.

integer | null

The user’s time zone (offset).

timestamp | null

Date and time of last activity.

integer

The user’s stars balance.

array

An array of users who were added to the group. Each item has the same structure as the items of the exist array.

array

An array of users skipped because they are excluded from automatic assignment. Items are user objects (the same structure as the nested user in exist items).For this method the array is always empty: exclusions only limit automatic assignment by org structure rules, and adding via the API counts as manual. The field is always present in the response — take it into account if you validate the schema strictly.

Manual addition removes a previously set exclusion: if the user was earlier removed from the group manually, after adding them via the API the automatic assignment rules can assign them again.

Permission requirements

Adding members to a group 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

Response parameters

Permission requirements

​Request headers

​Request parameters

​Response parameters

​Permission requirements

Request headers

Request parameters

Response parameters

Permission requirements