Insert a file to the "Common" section

POST /api/2.0/files/@common/insert

Request

Inserts a file specified in the request to the "Common" section by single file uploading.

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.

Body

fileobject

Request input stream

titlestring

File name

createNewIfExistarray of boolean

Specifies whether to create a new file if it already exists or not

keepConvertStatusboolean

Specifies whether to keep the file converting status or not

Examples

POST /api/2.0/files/@common/insert HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
  --url https://example.com/api/2.0/files/@common/insert \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Inserted file

Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring

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).