remove-group-leader.md

Remove Group Leader

Removes the role of Leader for a user in the current group/channel.

HTTP Method	URL	Requires Auth
POST	/api/v1/groups.removeLeader	yes

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The group ID.
userId*	oCHkav5Zf6vmpu2W2	The user ID.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/groups.removeLeader \
     -d '{
          "roomId": "ByehQjC44FwMeiLbX", 
          "userId": "oCHkav5Zf6vmpu2W2"}'

Example Response

Success

{
    "success": true
}

Error

If the user is not a leader, will return a 400 bad request status.

{
    "success": false,
    "error": "User is not a leader [error-user-not-leader]",
    "errorType": "error-user-not-leader"
}

Change Log

Version	Description
0.58.0	Added.