Skip to main content
PUT
/
unstable
/
documents
/
{documentId}
/
update-model
Update document model
curl --request PUT \
  --url https://{instance}.omniapp.co/api/unstable/documents/{documentId}/update-model \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "newModelId": "95e44907-68d0-4b0a-aa3e-fb2b2d971d76"
}
'
{
  "success": true,
  "message": "Document updated successfully"
}
This API is in beta and may have future breaking changes.

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

The identifier of the document to update. To retrieve the identifier, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document identifier.

Body

application/json
​
newModelId
string<uuid>
required

The ID of the new model to associate with the document. The new model must belong to the same organization and use the same database dialect as the current model.

Response

Document model updated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Document updated successfully"