Get Started
Portal api methods
Help

POST api/2.0/crm/{entityType}/{entityid}/files/upload This function requires authentication

Description

Upload file

Parameters
Name Description Type Example
entityType
sent in url
Entity type string some text
entityid
sent in url
Entity ID number 1234
Remark

Upload can be done in 2 different ways:

  1. Single file upload. You should set Content-Type & Content-Disposition header to specify filename and content type, and send file in request body
  2. Using standart multipart/form-data method

Example
POST api/2.0/crm/some+text/1234/files/upload
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

File info

Example Response

application/json

{
  "status": 0,
  "response": {
    "folderId": 12334,
    "version": 3,
    "versionGroup": 1,
    "contentLength": "12345",
    "fileStatus": 2,
    "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
    "fileType": 7,
    "fileExst": ".txt",
    "comment": null,
    "id": 90845414,
    "title": "Some titile.txt",
    "access": 1,
    "shared": false,
    "rootFolderType": 2,
    "updatedBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2019-10-15T09:54:28.0805677Z",
    "createdBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "updated": "2019-10-15T09:54:28.0805677Z",
    "providerItem": false
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <folderId>12334</folderId>
    <version>3</version>
    <versionGroup>1</versionGroup>
    <contentLength>12345</contentLength>
    <fileStatus>2</fileStatus>
    <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
    <fileType>7</fileType>
    <fileExst>.txt</fileExst>
    <comment />
    <id>90845414</id>
    <title>Some titile.txt</title>
    <access>1</access>
    <shared>false</shared>
    <rootFolderType>2</rootFolderType>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2019-10-15T09:54:28.0805677Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2019-10-15T09:54:28.0805677Z</updated>
    <providerItem>false</providerItem>
  </response>
</result>