Immediately preserve a customer's records or propose independent hold release or record disposition
/customers/{id}/record-controlsFresh customers:records:write staff authority required. hold immediately preserves the named record, or all current and future archive records for the customer when record_id is empty. release_hold, dispose and retention_event remain pending independent approval. Evidence and matter references required. An event names its original nonfuture occurrence and cannot rewrite an already captured trigger. Holds never release automatically.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
event_atstring · date-time or nullOptionalIndependently evidenced trigger, e.g. relationship closure
evidence_refstringRequiredevidence_sha256stringRequiredhold_idstringOptionalRelease_hold only
Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredHold, release_hold, dispose, retention_event
matter_refstringRequiredreasonstringRequiredrecord_idstringOptionalEmpty hold covers all current/future customer records
Returns
200 OK
customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
decided_atstring · date-time or nullOptionaldecided_bystringOptionalidstringRequiredproposed_atstring · date-timeRequiredproposed_bystringRequiredrequestobjectRequired8 child attributes
event_atstring · date-time or nullOptionalIndependently evidenced trigger, e.g. relationship closure
evidence_refstringRequiredevidence_sha256stringRequiredhold_idstringOptionalRelease_hold only
Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredHold, release_hold, dispose, retention_event
matter_refstringRequiredreasonstringRequiredrecord_idstringOptionalEmpty hold covers all current/future customer records
statusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503