v6

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

Documents

Update a document

This method allows you to modify an already created document

post/documents.update

Request body

idstring required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

titlestring

The title of the document.

textstring

The body of the document, may contain markdown formatting.

appendboolean

If true the text field will be appended to the end of the existing document, rather than the default behavior of replacing it. This is potentially useful for things like logging into a document.

publishboolean

Whether this document should be published and made visible to other team members, if a draft

doneboolean

Whether the editing session has finished, this will trigger any notifications. This property will soon be deprecated.

Example request

{
  "id": "hDYep1TPAM",
  "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"
    }
  }
}