Save Room Settings
- Print
- DarkLight
- PDF
Save Room Settings
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/rooms.saveRoomSettings
Changelog
| Version | Description |
|---|---|
| 3.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
{
"rid": "JZ8Y2dLfYhsg323Rf",
"roomName": "Test-Save-Room",
"roomDescription": "This is a test room."
}object
rid
string Required
The room ID.
roomName
string
The name of the room.
roomDescription
string
The description of the room.
roomAvatar
string
The base64 image.
featured
boolean
Whether the room is featured or not.
roomTopic
string
The topic of the room.
roomAnnouncement
string
The announcement of the room.
roomCustomFields
object
An object of the custom fields of the room.
roomType
string
The type of the room. It could be c for public rooms or p for private rooms.
readOnly
boolean
Whether the room is read-only or not.
reactWhenReadOnly
boolean
Whether users can react when the room is read-only.
systemMessages
Array of string
The system messages that the room supports.
string
default
boolean
Whether the room is the default room or not.
joinCode
string
The join code of the room.
streamingOptions
object
The streaming options of the room.
retentionEnabled
boolean
Whether retention is enabled for the room or not.
retentionMaxAge
string
The maximum age (in days) of messages to be retained in the room.
retentionExcludePinned
boolean
Whether to exclude pinned messages from retention or not.
retentionFilesOnly
boolean
Whether to retain only files in the room or not.
retentionIgnoreThreads
boolean
Whether to ignore threads when retaining messages or not.
retentionOverrideGlobal
boolean
Whether to override the global retention settings for the room or not.
encrypted
boolean
Whether the room is encrypted or not.
favorite
object
The favorite settings of the room. Whether the room is marked as favorite and whether it is set as the default room.
Responses
200
OK
Example 1
{
"rid": "JZ8Y2dLfYhsg323Rf",
"success": true
}object
rid
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" or \"roomName\" param provided does not match any group [error-room-not-found]",
"errorType": "error-room-not-found"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?