Set Default Channel
- Print
- DarkLight
- PDF
Set Default Channel
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/channels.setDefault
Set whether the channel is a default channel or not.
Changelog
| 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
Example 1
{
"roomId": "ByehQjC44FwMeiLbX",
"default": true
}object
roomId
string Required
The channel ID.
default
boolean Required
Boolean of whether the room is default or not.
Responses
200
OK
object
channel
object
_id
string
name
string
t
string
msgs
integer
u
object
_id
string
username
string
ts
string
ro
boolean
sysMes
boolean
_updatedAt
string
usernames
Array of string
string
joinCodeRequired
boolean
muted
Array of object
object
default
boolean
success
boolean
Was this article helpful?