Post
/api/v1/channels.removeLeader
Remove the leader role from a user in a channel.
Permission required: set-leader .
Changelog
| Version | Description |
|---|---|
| 0.75.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"roomId": "ByehQjC44FwMeiLbX",
"userId": "oCHkav5Zf6vmpu2W2"
}object
roomId
string Required
The channel's id
userId
string Required
The user's id
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
User is not a leader
{
"success": false,
"error": "User is not a leader [error-user-not-leader]",
"errorType": "error-user-not-leader"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string