Pin Version
POST /api/writing/documents/{document_id}/versions/{version_number}/pin
POST
/api/writing/documents/{document_id}/versions/{version_number}/pin
Pin a version snapshot so retention can’t evict it.
Pinned snapshots survive time-based auto-snapshot retention. Used by the version control UI to mark important checkpoints (e.g. “Final draft” or “Pre-revision”) as permanent.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” document_id
required
Document Id
string
version_number
required
Version Number
integer
Responses
Section titled “ Responses ”Successful Response
Response Pin Version Api Writing Documents Document Id Versions Version Number Pin Post
object
key
additional properties
boolean
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context