Создание группы

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

POST /groups.create

Описание

Создает новую приватную группу. Создатель группы всегда включается в список участников автоматически.

Параметры

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

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор создателя группы
name	да	string	Название группы
members	нет	array	Список пользователей для добавления в группу
readOnly	нет	boolean	Режим "только чтение". По умолчанию: false
showChatHistory	нет	boolean	Показывать историю чата новым участникам. По умолчанию: true

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/groups.create' \
  -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>",
  "name": "<GROUP_NAME>",
  "members": [
  "<MEMBER_ID_1>",
  "<MEMBER_ID_2>"
  ],
  "readOnly": false,
  "showChatHistory": true
  }'

Где:

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

Ответ

200 — Result of create a private channel — Группа создана. Пример вывода:

{
  "success": true,
  "group": {
    "_id": "private_group_123",
    "name": "project-alpha",
    "fname": "project-alpha",
    "t": "p",
    "msgs": 0,
    "usersCount": 1,
    "u": {
      "_id": "7w9BMr9r78W4RNe8x",
      "username": "john.doe"
    },
    "ts": "2026-06-24T10:00:00.000Z",
    "ro": false,
    "_updatedAt": "2026-06-24T10:00:00.000Z"
  }
}