v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB

Documents

Create a document

This method allows you to create or publish a new document. 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.create

Request body

titlestring required

textstring

The body of the document, may contain markdown formatting.

collectionIdstring uuid required

parentDocumentIdstring uuid

templateIdstring uuid

templateboolean

Whether this document should be considered to be a template.

publishboolean

Whether this document should be immediately published and made visible to other team members.

Example request

{
  "title": "Welcome to Acme Inc",
  "text": "…"
}

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"
    }
  }
}