Post
/api/v1/channels.setDescription
Set the description for a channel. Permission required: edit-room
.
Changelog
Version | Description |
---|---|
0.48.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": "ByehQjC44FwMeiLbX",
"description": "Test out everything"
}
object
roomId
string Required
The channel ID.
description
string Required
The description to set for the channel.
Responses
200
OK
Success
{
"description": "Testing the room",
"success": true
}
object
description
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string