ReferenceAdmin
Set retention periods (platform admins with a session; audited as retention.settings_update)
PUT
/v1/admin/retentionEach listed kind is set to the environment default (mode default), kept (keep) or deleted after days (days). Kinds not listed keep their current setting. The next run applies the change; check the dry-run report first.
Header Parameters
If-Match*string
The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/admin/retention" \ -H "If-Match: string" \ -H "Content-Type: application/json" \ -d '{ "periods": [ { "kind": "conversations", "mode": "default" } ] }'{ "data": { "periods": [ { "kind": "conversations", "days": 0, "source": "platform", "platformSet": true, "platformDays": 0, "environmentDays": 0, "minDays": 0, "maxDays": 0 } ], "levels": [ { "key": "string", "name": "string", "rank": 0, "conversationRetentionDays": 0, "anonymousRetentionHours": 0 } ], "updatedAt": "2019-08-24T14:15:22Z", "updatedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "revision": 0 }}