Start file editing

POST /api/2.0/files/file/{fileId}/startedit

Request

Informs about opening a file with the ID specified in the request for editing, locking it from being deleted or moved (this method is called by the mobile editors).

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

fileIdintegerformat: int32required

Body

editingAloneboolean

Examples

POST /api/2.0/files/file/6717/startedit HTTP/1.1
Accept: application/json
Content-Length: 26
Content-Type: application/json
Host: example.com

{
  "editingAlone": true
}
curl --request POST \
  --url https://example.com/api/2.0/files/file/6717/startedit \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "editingAlone": true
}'

Responses

200

File key for Document Service

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