retention-policies

Set or clear the data-retention policy for the current org

put/retention-policies/org

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

retentionDays30 | 90 | 180 | 365 | 730 nullable required

Days of inactivity after which conversation data is permanently deleted. Null disables retention (keep data forever). Must be one of the allowed windows.

Example request

{
  "retentionDays": 90
}

Response

Updated retention policy

retentionDaysnumber nullable required

Configured retention window in days, or null when retention is disabled (data kept forever).

enabledboolean required

Whether retention is currently enabled for the org.

allowedRetentionDaysnumber[] required

Retention windows (in days) the admin may choose from. Lets the UI render the selector without hardcoding the allowlist.

Example response

{
  "retentionDays": 90,
  "enabled": true,
  "allowedRetentionDays": [
    30,
    90,
    180,
    365,
    730
  ]
}

Changes

No recorded changes to this operation across all 51 revisions of this API.