Add Channel Owner
- Print
- DarkLight
- PDF
Add Channel Owner
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/channels.addOwner
Assign the owner role to a user in a channel.
Permission required: set-owner
Changelog
| Version | Description |
|---|---|
| 0.49.4 | 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 user ID that you want to set as the channel owner.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "User is already an owner [error-user-already-owner]",
"errorType": "error-user-already-owner",
"details": {
"method": "addRoomOwner"
}
}object
success
boolean
error
string
errorType
string
details
object
method
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?