Upload a user photo

POST /api/2.0/people/{userid}/photo

Request

Uploads a photo of the user with the ID specified in the 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: multipart/form-data.

Path

useridstringrequired

User ID

Body

formCollectionarray of object

Image data

keystring
valuearray of string

Examples

POST /api/2.0/people/4992/photo HTTP/1.1
Accept: application/json
Content-Length: 176
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com

-----011000010111000001101001
Content-Disposition: form-data; name="formCollection"
curl --request POST \
  --url https://example.com/api/2.0/people/4992/photo \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --form 'formCollection=[{"value":{"key":"some text","value":["some text"]}}]'

Responses

200

Result of file uploading

File upload result dto

successboolean

Specifies if the operation is successful or not

dataunknown

Data

messagestring

Message

401

Unauthorized

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