Updates settings to a room with ID specified in the request

PUT /api/2.0/files/rooms/{id}/settings

Request

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json, text/json, text/plain.
Content-Typeenum of string: Can be one of: application/json, application/*+json, text/json.

Path

idintegerformat: int32required

Body

indexingboolean

Examples

PUT /api/2.0/files/rooms/3325/settings HTTP/1.1
Accept: application/json
Content-Length: 22
Content-Type: application/json
Host: example.com

{
  "indexing": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/rooms/3325/settings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "indexing": true
}'

Responses

200

Room information

titlestring

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomAdmin - Room admin, Editing - Editing, PowerUser - Power user]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomAdmin, Editing, PowerUser.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room admin, 10 - Editing, 11 - Power user]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

createdobject

utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span

createdByobject

idstringformat: uuid
displayNamestring
titlestring
avatarstring
avatarOriginalstring
avatarMaxstring
avatarMediumstring
avatarSmallstring
profileUrlstring
hasAvatarboolean
isAnonimboolean

updatedobject

utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span

autoDeleteobject

utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span

rootFolderTypeone of

.enum of string

[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy, VirtualRooms, FillingFormsRoom, EditingRoom, CustomRoom, Archive, ThirdpartyBackup, PublicRoom, ReadyFormFolder, InProcessFormFolder, FormFillingFolderDone, FormFillingFolderInProgress.

.enum of integer

[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress]

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28.

updatedByobject

idstringformat: uuid
displayNamestring
titlestring
avatarstring
avatarOriginalstring
avatarMaxstring
avatarMediumstring
avatarSmallstring
profileUrlstring
hasAvatarboolean
isAnonimboolean

providerItemboolean

providerKeystring

providerIdintegerformat: int32

orderstring

idintegerformat: int32

rootFolderIdintegerformat: int32

originIdintegerformat: int32

originRoomIdintegerformat: int32

originTitlestring

originRoomTitlestring

canShareboolean

securityobject

Readboolean
Commentboolean
FillFormsboolean
Reviewboolean
Createboolean
Editboolean
Deleteboolean
CustomFilterboolean
EditRoomboolean
Renameboolean
ReadHistoryboolean
Lockboolean
EditHistoryboolean
CopyToboolean
Copyboolean
MoveToboolean
Moveboolean
Pinboolean
Muteboolean
EditAccessboolean
Duplicateboolean
SubmitToFormGalleryboolean
Downloadboolean
Convertboolean
CopySharedLinkboolean
ReadLinksboolean
Reconnectboolean
CreateRoomFromboolean
EditFormboolean
CopyLinkboolean
Embedboolean

parentIdintegerformat: int32

filesCountintegerformat: int32

foldersCountintegerformat: int32

isShareableboolean

isFavoriteboolean

newintegerformat: int32

muteboolean

tagsarray of unknown

logoobject

originalstring
largestring
mediumstring
smallstring
colorstring

pinnedboolean

roomTypeone of

.enum of string

[FillingFormsRoom - Form filling room, EditingRoom - Collaboration room, CustomRoom - Custom room, PublicRoom - Public room]

Can be one of: FillingFormsRoom, EditingRoom, CustomRoom, PublicRoom.

.enum of integer

[1 - Form filling room, 2 - Collaboration room, 5 - Custom room, 6 - Public room]

Can be one of: 1, 2, 5, 6.

privateboolean

typeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28.

inRoomboolean

quotaLimitintegerformat: int64

isCustomQuotaboolean

usedSpaceintegerformat: int64

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

401

Unauthorized

403

Forbidden

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Updates settings to a room with ID specified in the request

Request

Authorization

Headers

Path

Body

Examples

Responses

200

401

403

Results

Get Help