Set Channel Purpose

Post
/api/v1/channels.setPurpose

Set the purpose or description of the channel. It is the same as Set Channel Description. Permission required: edit-room

Changelog

Version Description
0.48.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": "WDuJLFkjwk6L7LdFC",
  "purpose": "greetings"
}
object
roomId
string Required

The channel's id

purpose
string Required

The description to set for the channel.

Responses
200

OK

Success
{
  "purpose": "greetings",
  "success": true
}
object
purpose
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string