Delete a Team

Prev Next
Post
/api/v1/teams.delete

Removes a team.

Permission required: delete-team

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