Skip to content
Orimora Docs

Update a document

PATCH
/api/v1/documents/{id}
 
curl --request PATCH \
  --url https://your-orimora-instance.example.com/api/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "text": "example", "content": "example", "published": true, "tags": [ "example" ] }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
object
title
string
<= 255 characters
text

Markdown body — replaces editor content when set

string
content

TipTap JSON — takes precedence over text when both are sent

published

True = publish, false = unpublish / draft

boolean
tags

Flat tag names to set (create-or-reuse). Replaces the document’s unrestricted tags; omit to leave tags untouched.

Array<string>
Example generated
{
  "title": "example",
  "text": "example",
  "content": "example",
  "published": true,
  "tags": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated document

Media type application/json
object
data
required
object
id
required
string format: uuid
title
required

Document title

string
emoji
required

Optional emoji prefix for the document icon

string | null
text
required

Plain-text content (read-only, derived from body)

string | null
collectionId
required
string | null format: uuid
parentDocumentId
required
string | null format: uuid
teamId
required
string format: uuid
createdById
required
string | null format: uuid
lastModifiedById
required
string | null format: uuid
publishedAt
required

Null = draft

string | null format: date-time
archivedAt
required
string | null format: date-time
deletedAt
required
string | null format: date-time
revision
required
integer
tags
required

The document’s unrestricted tag names (restricted/ACL tags are excluded)

Array<string>
sortOrder
required
number
fullWidth
required
boolean
collaborativeId
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example generated
{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "title": "example",
    "emoji": "example",
    "text": "example",
    "collectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "parentDocumentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "teamId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdById": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "lastModifiedById": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "publishedAt": "2026-04-15T12:00:00Z",
    "archivedAt": "2026-04-15T12:00:00Z",
    "deletedAt": "2026-04-15T12:00:00Z",
    "revision": 1,
    "tags": [
      "example"
    ],
    "sortOrder": 1,
    "fullWidth": true,
    "collaborativeId": "example",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Human-readable error message

string
Example generated
{
  "error": "example"
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Human-readable error message

string
Example generated
{
  "error": "example"
}