Add Channel Owner

Prev Next
Post
/api/v1/channels.addOwner

Assign the owner role to a channel member. See Room Roles for details about the roles.

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
{
  "roomId": "WDuJLFkjwk6L7LdFC",
  "userId": "b66oZ8i9pkeSko33v"
}
object
roomId
string Required

The channel 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

User is alrready an owner
{
  "success": false,
  "error": "User is already an owner [error-user-already-owner]",
  "errorType": "error-user-already-owner",
  "details": {
    "method": "addRoomOwner"
  }
}
Expand All
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