Создание канала

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

POST /channels.create

Описание

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

Параметры

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

Название	Обязательный	Тип данных	Описание
userId	да	string	Идентификатор создателя канала
name	да	string	Название канала
members	нет	array	Список пользователей для добавления в канал

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.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": "<CHANNEL_NAME>",
  "members": [
  "<MEMBER_ID_1>",
  "<MEMBER_ID_2>"
  ]
  }'

Где:

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

Ответ

200 — Result of create a channel — Канал создан. Пример вывода:

{
  "success": true,
  "channel": {
    "_id": "GENERAL",
    "name": "general",
    "fname": "general",
    "t": "c",
    "msgs": 0,
    "usersCount": 1,
    "u": {
      "_id": "7w9BMr9r78W4RNe8x",
      "username": "john.doe"
    },
    "ts": "2026-06-24T10:00:00.000Z",
    "ro": false,
    "default": false,
    "_updatedAt": "2026-06-24T10:00:00.000Z"
  }
}