Skip to content
AcrivaDocs

UpdateRetentionRule

PUT
/api/v1/t/{tenant}/compliance/retention-rules/{documentTypeId}
curl --request PUT \
  --url https://example.com/api/v1/t/example/compliance/retention-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "periodYears": 1, "startSource": "DateField", "startFieldKey": "example", "legalBasis": "example", "personalData": true, "version": 1 }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

documentTypeId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
periodYears
required
null | integer format: int32
startSource
required
Allowed values: DateField Arrival
startFieldKey
required
null | string
legalBasis
required
null | string
personalData
required
boolean
version
required
integer format: uint32

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
null | string format: uuid
documentTypeId
required
string format: uuid
periodYears
required
null | integer format: int32
startSource
required
Allowed values: DateField Arrival
startFieldKey
required
null | string
legalBasis
required
null | string
personalData
required
boolean
reviewRequired
required
boolean
documentCount
required
integer format: int32
updatedAt
required
null | string format: date-time
version
required
integer format: uint32
fixed
required
boolean
Example
{
  "startSource": "DateField"
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}