Comment on page

Group Add Leader

Gives the role of Leader for a user in the current group.
URL
Requires Auth
HTTP Method
/api/v1/groups.addLeader
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.addLeader \
     -d '{"roomId": "ByehQjC44FwMeiLbX", "userId": "oCHkav5Zf6vmpu2W2"}'
Success Example Result
{
    "success": true
}
Bad Request Example Result
If the user is already a leader, will return a 400 bad request status.
{
    "success": false,
    "error": "User is already a leader [error-user-already-leader]",
    "errorType": "error-user-already-leader"
}
Change Log
Version
Description
0.58.0
Added.

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

Argument	Example	Required	Description
`roomId`	`ByehQjC44FwMeiLbX`	Required	The groups's id
`userId`	`oCHkav5Zf6vmpu2W2`	Required	The user's id

Version	Description
0.58.0	Added.

Last modified 1yr ago