Delete a Team

Article summary

Did you find this summary helpful?

Thank you for your feedback

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 1

{
  "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

Success

{
  "success": true
}

object

success

boolean

Was this article helpful?