Skip to main content
POST
Change document retention or lifecycle
Use a valid workspace bearer session. An API key cannot authorize this endpoint. The current workspace and environment are derived from that session. See information handling for file limits, versioning, holds, retention and disposal behavior.

Authorizations

Authorization
string
header
required

JWT for user-initiated operations

Path Parameters

id
string<uuid>
required

Document identifier in the current workspace environment.

Body

application/json
action
enum<string>
required
Available options:
archive,
restore,
retention,
purge
reason
string
required
Required string length: 10 - 2000
confirmed
enum<boolean>
required

Confirm the reviewed action. Purge permanently removes eligible file contents.

Available options:
true

For retention actions. An active hold blocks purge.

retain_until
string<date-time> | null

For retention actions. Include the existing date when changing a hold. An existing date cannot be shortened or cleared.

Response

Successful response

status
enum<string>
Available options:
confirmed