Post
/api/v1/teams.delete
Removes a team.
Permission required: delete-team
The deletion completes even if the team's main room no longer exists, for example after an interrupted deletion. In that case, the main room is skipped, the team is removed, and the team name becomes available again. You can retry an interrupted deletion with this endpoint.
Changelog
| Version | Description |
|---|---|
| 8.9.0 | Succeeds when the main room is missing. |
| 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
Example
{
"teamId": "mLGZGywfmLGZGywf",
"roomsToRemove": [
"8dugqGhuRvCBLdZft"
]
}object
teamName
string
Enter the team name. This parameter is required if teamId is not provided.
teamId
string
Enter the team ID. This parameter is required if teamName is not provided.
roomsToRemove
Array of string
The room IDs to delete along with the team.
string
Example8dugqGhuRvCBLdZft
Responses
200
OK
Success
{
"success": true
}object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string