Comment on page

Channel Remove Leader

Removes the role of Leader for a user in the current channel.
It requires the set-leader permission.
URL
Requires Auth
HTTP Method
/api/v1/channels.removeLeader
yes
POST
Payload
Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The channel'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" \
     https://localhost:3000/api/v1/channels.removeLeader \
     -d '{"roomId": "ByehQjC44FwMeiLbX", "userId": "oCHkav5Zf6vmpu2W2"}'
Example Result
Success 
{
    "success": true
}
Error
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
Not Allowed: This occurs when the authenticated user doesn't have the set-leader permission.
User is not a leader: This occurs when the user is not a leader in the channel.
Authorization
Not Allowed
User is already a leader
{
    "status": "error",
    "message": "You must be logged in to do this."
}
{
    "success": false,
    "error": "Not allowed [error-not-allowed]",
    "errorType": "error-not-allowed",
    "details": {
        "method": "removeRoomLeader"
    }
}
{
    "success": false,
    "error": "User is not a leader [error-user-not-leader]",
    "errorType": "error-user-not-leader"
}
Change Log
Version
Description
0.75.0
Added.

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

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

Version	Description
0.75.0	Added.

Last modified 2mo ago