Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.24 KB

removeleader.md

File metadata and controls

50 lines (37 loc) · 1.24 KB
Raw

Group Remove Leader

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

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

Payload

Argument Example Required Description
roomId ByehQjC44FwMeiLbX Required The groups's id
userId oCHkav5Zf6vmpu2W2 Required The user's 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"}'

Success Example Result

{
    "success": true
}

Bad Request Example Result

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.