Post
/api/v1/teams.create
Create a new public or private team in the workspace.
Permission required: create-team. When you create a team from an existing room by passing room.id, you also need the edit-room permission for that room.
Changelog
| Version | Description |
|---|---|
| 8.7.0 | Enforced room permission checks when creating a team from an existing room. |
| 3.13.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Create a public team
{
"name": "teamName",
"type": 0,
"members": [
"8dugqGhuRvCBLdZft"
],
"room": {
"readOnly": true
},
"sidepanel": {
"items": [
"discussions",
"channels"
]
}
}Create a team from an existing room
{
"name": "teamName",
"type": 0,
"room": {
"id": "6513afeda2f73c7460e18c86"
}
}object
name
string Required
The team name.
type
integer Required
Privacy of the team (0 - Public, 1 - Private).
members
Array of string
The user IDs to add to the team when it is created.
string
room
object
id
string
The ID of an existing room to use as the team's main room.
readOnly
boolean
sidepanel
object
List the team's channels or discussions to be displayed in the sidepanel.
items
Array of string
The options are discussions and channels.
string
Example["discussions", "channels"]
owner
string
Set the owner of the team.
Responses
200
OK
Note that the roomId is main room ID of the team.
Team created
{
"team": {
"_id": "651619e3a2f73c7460e18cc5",
"name": "teamName",
"type": 0,
"createdAt": "2023-09-29T00:27:15.189Z",
"createdBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
},
"_updatedAt": "2023-09-29T00:27:15.189Z",
"roomId": "651619e3a2f73c7460e18cc7"
},
"success": true
}object
team
object
_id
string
name
string
type
integer
createdAt
string
createdBy
object
_id
string
username
string
_updatedAt
string
roomId
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Missing room permissions
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string