Documents

Import a file as a document

This method allows you to create a new document by importing an existing file. By default a document is set to the collection root. If you want to create a nested/child document, you should pass parentDocumentId to set the parent document.

post/documents.import

Response

Example response

{
  "data": {
    "title": "🎉 Welcome to Acme Inc",
    "emoji": "🎉",
    "text": "…",
    "urlId": "hDYep1TPAM",
    "collaborators": [
      {
        "name": "Jane Doe"
      }
    ],
    "createdBy": {
      "name": "Jane Doe"
    },
    "updatedBy": {
      "name": "Jane Doe"
    }
  }
}

Changes

Changed in 2 of the 6 revisions of this API.10

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d9See the full diff
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 404 status
  response-optional-property-added

Full history