Добавление участников в команду
Метод и конечная точка
POST/teams/{teamId}/members
Описание
Добавляет новых участников в команду. Можно также добавить участников в указанные каналы команды.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| teamId | да | string | Идентификатор команды (в пути) |
| membersIds | да | array | Список ID пользователей для добавления |
| roomIds | нет | array | Список каналов команды для добавления участников |
Запрос
curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/teams/<TEAM_ID>/members' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"membersIds": [
"<MEMBER_ID_1>",
"<MEMBER_ID_2>"
],
"roomIds": [
"<ROOM_ID_1>",
"<ROOM_ID_2>"
]
}'
Где:
<ENV>— окружение, на котором выполняется запрос;<DEFAULT_DOMAIN>— домен сервера Squadus;<USER_ID>— идентификатор пользователя, от имени которого выполняется запрос;<AUTH_TOKEN>— токен аутентификации пользователя;<TEAM_ID>— идентификатор команды;<MEMBER_ID_1>,<MEMBER_ID_2>— идентификаторы добавляемых пользователей;<ROOM_ID_1>,<ROOM_ID_2>— идентификаторы каналов.
Ответ
200 — List of added users — Список добавленных пользователей. Пример вывода:
{
"success": true,
"data": {
"addedUserIds": [
"user_123",
"user_456"
]
}
}