delete-a-team.md

Delete a Team

HTTP Method	URL	Requires Auth
POST	/api/v1/teams.delete	yes

{% hint style="info" %} Permission required: delete-team {% endhint %}

Body Parameters

Key	Example Value	Description
teamId* or teamName*	ByehQjC44FwMeiLbX team1	The team ID or the team name. You must enter either one of these parameters.
roomsToRemove	["8dugqGhuRvCBLdZft"]	The room ID. to delete along with the team.

Example Call

curl  -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
      -H "X-User-Id: ew28FnZqipDpvKw3R" \
      -H "Content-type: application/json" \
      http://localhost:3000/api/v1/teams.delete \
      -d '{ 
            "teamId": "Isjsldk32sdkfA" }'

Example Response

{
  "success": true
}