Herald
OpenapiLegal

Revert a realm's agreement to the platform default.

Admin — requires `inject_identity` + `settings.manage` + `has_access_to_realm`. Implemented as **snapshot semantics** in the service: the current default body is copied into a brand-new custom version (new `version_id`, monotonic `version_no`), so existing user consent no longer matches and reconsent is triggered. No prior rows are deleted. The handler is a thin pass-through.

DELETE
/api/legal/admin/{realmId}/agreements/{agreementType}/custom

Admin — requires inject_identity + settings.manage + has_access_to_realm. Implemented as snapshot semantics in the service: the current default body is copied into a brand-new custom version (new version_id, monotonic version_no), so existing user consent no longer matches and reconsent is triggered. No prior rows are deleted. The handler is a thin pass-through.

Path Parameters

realmId*string

Realm ID

agreementType*string

Agreement type: terms_of_service | privacy_policy

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/legal/admin/string/agreements/string/custom"
{  "effective_at": "2019-08-24T14:15:22Z",  "external_url": "string",  "mode": "full_text",  "version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",  "version_no": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}