跳到主要内容

CreateRoomFromTemplateDto

The parameters of a room built from a room template.

NameTypeDescriptionNotes
templateIdInteger (int32)The room template to copy. Templates live in their own section and are listed by GET api/2.0/files/rooms with a search area of 4; an ordinary room id is rejected here.[required] [example: 42]
titleStringThe name of the room to create. It is sanitised and truncated the way a room title is, and a blank value is rejected; the title of the template is not reused.[required] [example: Project Alpha] [minLength: 0] [maxLength: 170] [nullable]
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. It is ignored when the logo of the template is copied instead.[optional]
copyLogoBooleanWhether the new room keeps the logo of the template. With it on the uploaded picture is ignored; with it off the room starts with no logo unless one is supplied.[optional] [example: false]
tagsListThe labels to attach to the room, by name. Names the portal tag catalogue does not hold yet are added to it, and GET api/2.0/files/tags lists what already exists. Leaving the field out keeps the tags of the template.[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] [minLength: 0] [maxLength: 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]
quotaLong (int64)The storage the room may take, in bytes. It is accepted only while the per-room quota feature is on for the portal and must stay inside the portal own limit; leaving it out lets the room follow the portal default.[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. Leaving it out keeps the setting of the template.[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. Leaving it out keeps the setting of the template.[optional] [example: false] [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. Leaving the field out keeps the setting of the template.[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. Leaving the field out keeps the setting of the template.[optional]
privateBooleanWhether the room is end-to-end encrypted. Its files can then be opened only in the desktop application by members whose encryption keys are set up, and the flag cannot be changed after the room is created.[optional] [example: false] [nullable]