Links

Leave a Team

Causes the request sender to be removed from the team.
HTTP Method
URL
Requires Auth
POST
/api/v1/teams.leave
yes

Body Parameters

Key
Example Value
Description
teamId* or teamName*
ByehQjC44FwMeiLbX or team1
The team ID or the team name. You must enter either one of these parameters.
rooms
["8dugqGhuRvCBLdZft"]
The team room IDs to remove the user from.

Example Call

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

Example Response

{
"success": true
}
Last modified 2mo ago
Rocket.Chat versions receive support for six months after release.