Update document version content or status
Send exactly one request form: content-only or status-only. Content is editable only while the version is a draft, except `version_changelog`, which is also…
Send exactly one request form: content-only or status-only. Content is
editable only while the version is a draft, except version_changelog,
which is also allowed on published and archived versions. Only draft or
archived versions can be published. Publishing does not activate a version.
Base-only document fields belong on PATCH /api/v1/documents/{id}.
title is a version content field only for a non-default locale.
Authorization
bearerAuth In: header
Path Parameters
uuidRequired version UUID
uuidQuery Parameters
This value takes precedence over x-locale. An invalid or disabled explicit value returns 400.
Header Parameters
Used when the locale query value is absent. The tenant default locale is the fallback only when both locale inputs are absent. An invalid or disabled explicit value returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "description_markdown": "# Privacy Policy\\n\\nUse **approved** controls.", "version_changelog": "Clarify approved controls." }'{ "success": true, "data": { "id": "550e8400-e29b-41d4-a716-446655440000" }}How is this guide?