POST api/2.0/files/rooms This function requires authentication

Description

Creates a room in the "Rooms" section.

Parameters
Name Description Type Example
Title
sent in body
Room name System.String
RoomType
sent in body
Room type ASC.Files.Core.ApiModels.RequestDto.RoomType
Private
sent in body
Private room or not System.Boolean
Share
sent in body
Collection of sharing parameters System.Collections.Generic.IEnumerable{ASC.Files.Core.ApiModels.FileShareParams}
Notify
sent in body
Notifies users about the shared room or not System.Boolean
SharingMessage
sent in body
Message to send when notifying about the shared room System.String
Example
POST api/2.0/files/rooms
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Title": "some text",
  "RoomType": "EditingRoom",
  "Private": true,
  "Notify": true,
  "SharingMessage": "some text"
}
Returns

Room information

Example Response

application/json

{
  "status": 0,
  "response": {
    "ParentId": 1234,
    "FilesCount": 1234,
    "FoldersCount": 1234,
    "New": 1234,
    "Mute": true,
    "Pinned": true,
    "Private": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <ParentId>1234</ParentId>
    <FilesCount>1234</FilesCount>
    <FoldersCount>1234</FoldersCount>
    <New>1234</New>
    <Mute>True</Mute>
    <Pinned>True</Pinned>
    <Private>True</Private>
  </response>
</result>