Set Channel Topic

Prev Next
Post
/api/v1/channels.setTopic

Set the topic for a channel. Permission required: edit-room.

Changelog

Version Description
0.13.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",
  "topic": "Discuss all of the testing"
}
object
roomId
string Required

The channel's ID.

topic
string Required

The channel's topic

Responses
200

OK

Success
{
  "topic": "Discuss all of the testing",
  "success": true
}
object
topic
string
success
boolean
401

Unauthorized

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