Skip to content

Sets an ACTIVE hold immediately — no approval gate, because preservation is the safe direction and the duty to preserve admits no waiting (§4).

POST
/v1/m/compliance/holds
curl --request POST \
--url https://example.com/v1/m/compliance/holds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "data_class": "example", "matter_ref": "example", "on_behalf_of": "example", "reason": "example", "scope_kind": "tenant", "subject_kind": "example", "subject_ref": "example", "title": "example" }'

Sets an ACTIVE hold immediately — no approval gate, because preservation is the safe direction and the duty to preserve admits no waiting (§4).

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
data_class
string
matter_ref
required
string
on_behalf_of
string
reason
required
string
scope_kind
required
string
Allowed values: tenant data_class subject
subject_kind
string
subject_ref
string
title
string

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}