Groundeddocs
ReferenceAdmin

Release a legal hold (platform admins with a session; audited as legal_hold.release)

POST/v1/admin/legal-holds/{holdId}/release

Retention deletes what the hold kept, if its period has passed, at the next run. 409 legal_hold_released when it was already released.

Path Parameters

holdId*string
Formatuuid

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 POST "https://example.com/v1/admin/legal-holds/497f6eca-6276-4993-bfeb-53cbbbba6f08/release" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "scopeType": "user",    "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",    "scopeLabel": "string",    "scopeExists": true,    "scopeContext": "string",    "reason": "string",    "coversFrom": "2019-08-24",    "coversTo": "2019-08-24",    "status": "active",    "createdAt": "2019-08-24T14:15:22Z",    "createdBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "displayName": "string",      "email": "string"    },    "releasedAt": "2019-08-24T14:15:22Z",    "releasedBy": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "displayName": "string",      "email": "string"    },    "releaseReason": "string",    "conversations": 0,    "deletedConversations": 0  }}