Skip to main content

CreateThirdPartyRoomRequest

The room to be created out of a folder of a connected third-party storage account.

NameTypeDescriptionNotes
createAsNewFolderBooleanCreates a new folder named after title inside the folder named in the path and turns that subfolder into the room, leaving the named folder itself untouched. When omitted, the named folder becomes the room and keeps everything it already holds.[optional] [example: false]
titleStringThe name the room is shown under. It is stored on the connected account, so it does not have to match the name of the folder in the storage; with createAsNewFolder it is also the name given to the created subfolder.[required] [example: Third-party project room] [nullable]
roomTypeRoomTypeThe kind of room the folder becomes, which decides the default access rules of its members and cannot be changed afterwards.[required] [enum: 1, 2, 5, 6, 8, 9]
privateBooleanRestricts the room to the members explicitly invited into it. The flag is kept on the connected storage account rather than on the folder, so every folder read through that account reports the same value.[optional] [example: false]
indexingBooleanKeeps the contents of the room in an explicit numbered order, the one reported as order on every entry, instead of leaving the order to the reader.[optional] [example: true]
denyDownloadBooleanForbids downloading and printing the contents of the room, which leaves the members with viewing and editing in the editor only.[optional] [example: false]
colorStringThe background colour drawn behind the cover of the room, as six hexadecimal digits without a leading number sign. An empty value restores the colour the portal picks by default.[optional] [example: FF5733] [nullable]
coverStringThe drawing shown on the room tile, named by one of the built-in cover identifiers returned by GET api/2.0/files/rooms/covers. An empty value leaves the room without a cover, and any other unknown value is rejected as an invalid request.[optional] [example: bookmark] [nullable]
tagsListThe tags to attach to the room, named by their text. A name that is not in the portal tag catalogue yet is added to it, and GET api/2.0/files/tags lists the names already there.[optional] [example: [Marketing, Q3]] [nullable]
logoLogoRequestThe picture to use as the room logo, which has to be uploaded with POST api/2.0/files/logos first; leaving it out keeps the room on its cover and colour.[optional]