Skip to main content

UpdateRoomRequest

The fields of a room that a partial update changes.

NameTypeDescriptionNotes
titleStringThe new name of the room. It is trimmed and sanitised the way a room title is at creation, and a blank or missing value leaves the current name alone rather than clearing it.[optional] [example: Project Alpha] [minLength: 0] [maxLength: 170] [nullable]
quotaLong (int64)The new storage limit of the room, in bytes. A value of -1 leaves the room with no limit of its own, any other negative value puts it back on the portal default, and a positive one is accepted only while the per-room quota feature is on.[optional] [example: 1073741824] [nullable]
indexingBooleanWhether the room keeps a manual order of its contents. With it on every file and folder carries a position that listings follow and that PUT api/2.0/files/rooms/{id}/reorder compacts; with it off the contents are ordered by the sorting of the request. Turning it on renumbers the existing contents at once.[optional] [example: true] [nullable]
denyDownloadBooleanWhether members without editing rights are stopped from downloading and printing the contents of the room. They can still open the documents in the editor.[optional] [example: true] [nullable]
lifetimeRoomDataLifetimeDtoHow long files may stay in the room before they are deleted automatically. The countdown starts when the setting is saved, and leaving the field out keeps the files forever. Sending it with the switch off stops the automatic deletion.[optional]
watermarkWatermarkRequestDtoThe watermark drawn over documents opened in the room. Leaving the field out adds no watermark, and sending it with the switch turned off removes the one the room has.[optional]
logoLogoRequestThe picture to use as the room logo, named by the path that POST api/2.0/files/logos returned for an image uploaded beforehand, plus the crop to take from it. Leaving the field out keeps the room on its cover and colour.[optional]
tagsListThe labels the room is to carry from now on. The list replaces the whole tag set rather than adding to it, an empty list clears it, and names the portal catalogue does not hold yet are added to it.[optional] [example: [Finance, 2026]] [nullable]
colorStringThe background colour the room is drawn with while it has no logo, as six hexadecimal digits with no leading number sign. An empty value restores the default colour of the room type.[optional] [example: FF5733] [pattern: /^[0-9a-fA-F]{6}$/] [nullable]
coverStringThe picture drawn on the room while it has no logo, named by an identifier from GET api/2.0/files/rooms/covers. Any other value is rejected, and an empty value leaves the room without a cover.[optional] [example: bookmark] [minLength: 0] [maxLength: 50] [nullable]
chatSettingsChatSettingsThe model and the prompt an AI room answers with. It belongs to AI rooms only and is rejected for a room of any other kind.[optional]
sendFormToExternalDBBooleanFor a form filling room, whether the data of every completed submission is also pushed to the external database configured for the portal. It is what POST api/2.0/files/rooms/{id}/externaldbsync re-runs for the forms already collected.[optional] [example: false] [nullable]
saveFormAsXLSXBooleanFor a form filling room, whether the collected submissions are also gathered into a spreadsheet stored next to the completed forms. With it off the submissions are kept only as the filled documents themselves.[optional] [example: false] [nullable]