ReferenceAdmin
Change the platform retention periods (platform admins)
PUT
/v1/admin/settings/retentionEach listed kind is replaced; kinds not listed are kept. 422 invalid_period with details.kind and details.reason (out_of_range, duplicate). A shorter period deletes at the next run (every RETENTION_INTERVAL). Audited as settings.retention_update.
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
application/json
curl -X PUT "https://example.com/v1/admin/settings/retention" \ -H "If-Match: string" \ -H "Content-Type: application/json" \ -d '{ "periods": [ { "kind": "call_metadata", "days": 1 } ] }'{ "data": { "periods": [ { "kind": "call_metadata", "days": 0, "builtInDays": 0, "minDays": 0, "maxDays": 0, "teamOverridable": true } ], "revision": 0, "updatedAt": "2019-08-24T14:15:22Z", "lastRun": { "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "deleted": { "property1": 0, "property2": 0 }, "errors": { "property1": "string", "property2": "string" } } }}