remove-member-from-team.md

Remove Member from Team

Requires edit-team-member permission.

HTTP Method	URL	Requires Auth
POST	/api/v1/teams.removeMember	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.
userId*	ew28FnZqipDpvKw3R	The user ID to be removed from the team.
rooms	["8dugqGhuRvCBLdZft"]	The room IDs from which the user should be removed.

Example Call

curl  -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
      -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
      -H "Content-type: application/json" \
      http://localhost:3000/api/v1/teams.removeMember \
      -d '{ 
            "teamName": "team1", 
            "userId": "kRwRRzfNybEDfQeij" }'

Example Response

{
  "success": true
}