Create a folder structure

POST /api/2.0/files/folders/{folderId}

Request

Creates a new folder structure specified in the request in a folder with a specific ID.

Authorization

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

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

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

folderIdstring

Parent folder ID

Body

relativePathsarray of string

Relative paths to create a folder structure

Examples

POST /api/2.0/files/folders/%7BfolderId%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/files/folders/%7BfolderId%7D \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Main folder contents

TotalFilesintegerformat: int32
TotalSubFoldersintegerformat: int32
Shareableboolean
NewForMeintegerformat: int32
FolderUrlstring
IsFavoriteboolean
IDobject
Titlestring
CreateBystringformat: uuid
CreateByStringstring
CreateOnStringstring
ModifiedOnStringstring
ModifiedBystringformat: uuid
ModifiedByStringstring
Errorstring
Accessenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

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

Sharedboolean
ProviderIdintegerformat: int32
ProviderKeystring
FolderIdDisplayobject
DeletedPermanentlyOnStringstring
DenyDownloadboolean
DenySharingboolean

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, 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).