ReferenceAdmin
Run retention now (platform admins with a session; audited as retention.run_request)
POST
/v1/admin/retention/runsQueues a run of the given kinds (every kind when none are given). It starts after any run in progress; follow it in the runs list. It deletes what the dry-run report shows as due.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/admin/retention/runs" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": 0, "trigger": "schedule", "requestedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayName": "string", "email": "string" }, "kinds": [ "conversations" ], "status": "queued", "results": [ { "kind": "conversations", "deleted": 0, "held": 0, "kept": true, "error": "string" } ], "error": "string", "createdAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z" }}