Archive

Extend tenant retention class

Statutory classes are immutable; existing class duration cannot decrease. Existing entries are marked for durable reconciliation. Returns 202 while protection work remains, or 503 if a version within one day of expiry still awaits extension. Retrying identical input advances pending work without resetting completed entries.

PUT/api/archive/retention-classes/{code}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth
oauth2oauth2required

No description provided.

Path Parameters

code
stringrequired

No description provided.

Request Body

application/json
required
{
  "code": "string",
  "name": "Example name",
  "durationYears": 1,
  "startMode": "document-year-end",
  "deletionMode": "automatic",
  "description": "Example description",
  "legalBasis": "string",
  "statutory": true,
  "reconciliationPending": 1,
  "reconciliationUrgent": 1
}

Response

200application/json

Successful response

code
stringrequired
name
stringrequired
durationYears
integerrequired
startMode
enum<string>required

Available options: document-year-enddocument-dateevent

deletionMode
enum<string>required

Available options: automaticmanual

description
string | null
legalBasis
string | null
statutory
boolean

Available options: truefalse

reconciliationPending
integer
reconciliationUrgent
integer