Set Default Channel

Prev Next
Post
/api/v1/channels.setDefault

Set whether the channel is a default channel or not. All new users will automatically join this channel. Permission required: edit-room

Version Description
0.66.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
object
roomId
string Required

The channel ID.

default
boolean Required

Boolean of whether the room is default or not.

Responses
200
401

OK

Collapse all
object
channel
object
_id
string
name
string
t
string
msgs
integer
u
object
ts
string
ro
boolean
sysMes
boolean
_updatedAt
string
usernames
Array of string
string
joinCodeRequired
boolean
muted
Array of object
object
default
boolean
success
boolean