v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Retention policies

Update retention policy

Updates a retention policy.

put/retention_policies/{retention_policy_id}

Path parameters

retention_policy_idstring required

The ID of the retention policy.

Request body

policy_namestring nullable

The name for the retention policy.

descriptionstring nullable

The additional text description of the retention policy.

retention_typestring nullable

Specifies the retention type:

modifiable: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.
non-modifiable: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.

When updating a retention policy, you can use non-modifiable type only. You can convert a modifiable policy to non-modifiable, but not the other way around.

statusstring nullable

Used to retire a retention policy.

If not retiring a policy, do not include this parameter or set it to null.

can_owner_extend_retentionboolean nullable

Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.

are_owners_notifiedboolean nullable

Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.

Example request

{
  "policy_name": "Some Policy Name",
  "description": "Policy to retain all reports for at least one month",
  "retention_type": "non-modifiable",
  "status": "retired",
  "custom_notification_recipients": [
    {
      "id": "11446498",
      "type": "user"
    }
  ]
}

Response

Returns the updated retention policy object.

idstring required

The unique identifier that represents a retention policy.

type'retention_policy' required

The value will always be retention_policy.

policy_namestring

The name given to the retention policy.

retention_lengthstring int32

The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a policy_type of indefinite, the retention_length will also be indefinite.

disposition_action'permanently_delete' | 'remove_retention'

The disposition action of the retention policy. This action can be permanently_delete, which will cause the content retained by the policy to be permanently deleted, or remove_retention, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired.

descriptionstring

The additional text description of the retention policy.

policy_type'finite' | 'indefinite'

The type of the retention policy. A retention policy type can either be finite, where a specific amount of time to retain the content is known upfront, or indefinite, where the amount of time to retain the content is still unknown.

retention_type'modifiable' | 'non_modifiable'

Specifies the retention type:

modifiable: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.
non-modifiable: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.

status'active' | 'retired'

The status of the retention policy. The status of a policy will be active, unless explicitly retired by an administrator, in which case the status will be retired. Once a policy has been retired, it cannot become active again.

created_atstring date-time

When the retention policy object was created.

modified_atstring date-time

When the retention policy object was last modified.

can_owner_extend_retentionboolean

Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.

are_owners_notifiedboolean

Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.

Example response

{
  "id": "12345",
  "type": "retention_policy",
  "policy_name": "Some Policy Name",
  "retention_length": "365",
  "disposition_action": "permanently_delete",
  "description": "Policy to retain all reports for at least one month",
  "policy_type": "finite",
  "retention_type": "non_modifiable",
  "status": "active",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "custom_notification_recipients": [
    {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com"
    }
  ],
  "assignment_counts": {
    "enterprise": 1,
    "folder": 1,
    "metadata_template": 1
  }
}