Skip to main content
PATCH
/
v1
/
documents
/
{documentId}
Update document
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "clearExistingDraft": true
}
'
{
  "identifier": "doc-123",
  "name": "New Document Name"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
documentId
string
required

Document identifier

Body

application/json
​
name
string

New name for the document.

Required string length: 1 - 255
​
description
string

Updated description of the document. Set as null to clear the description.

Maximum string length: 1024
​
clearExistingDraft
boolean

If true, discards any existing draft before renaming.

Note: This parameter is required when a draft exists for the document.

Response

Document renamed successfully

​
identifier
string

The document identifier

​
name
string

The new document name