Add Channel Leader
- Print
- DarkLight
- PDF
Add Channel Leader
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/channels.addLeader
Assign the role of leader to a user in the current 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 1
{
"roomId": "WDuJLFkjwk6L7LdFC",
"userId": "b66oZ8i9pkeSko33v"
}object
roomId
string Required
The channel's id
userId
string Required
The userId of the user to be made leader
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "User is already a leader [error-user-already-leader]",
"errorType": "error-user-already-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
Was this article helpful?