Change document versioning state

Server URLloading...

PATCH

/api/v1/documents/{id}/versioning

Send

Authorization

Path

Body

To disable versioning, the API uses the active published version as the source, or the newest published version when no active published version exists. It copies the source version fields and status into the base document, then sets versioning to false. A document without a source version changes only the flag. This action does not delete, archive, deactivate, or otherwise mutate retained versions.

While versioning is disabled, the default document read and version=base both return base content. Retained versions do not control returned content, even when active_version contains their UUID. Base changes continue through PATCH /api/v1/documents/{id}.

To enable versioning, the API does not create a draft or mutate retained versions. Normal promoted-content selection resumes and a retained active published version can become effective again.

Path Parameters

Response Body

curl -X PATCH "https://example.com/api/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versioning" \  -H "Content-Type: application/json" \  -d '{    "versioning": false  }'

{  "success": true,  "data": {    "versioning": false  }}