Set Channel ReadOnly

Prev Next
Post
/api/v1/channels.setReadOnly

Set a channel to be read-only or not. Permission required: edit-room

Version Description
0.49.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.

readOnly
boolean Required

Boolean of whether the room is read-only 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
success
boolean