Update legal hold
Renames or re-describes a hold, or widens and narrows its workspace-wide coverage. Toggling coverage never touches the custodians the hold names. A released hold cannot be updated.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The legal hold id
^lgh_[a-zA-Z0-9]{14}$"lgh_Abc123XyZ456De"
Body
A new name for the matter
1 - 200"X v. Y (consolidated)"
New free text for the matter, or null to clear it
2000"Preservation notice 2026-08-12"
Whether the hold covers every member of your workspace. Toggling this never touches the custodians the hold names.
true
Response
The updated legal hold
The unique identifier for the legal hold
^lgh_[a-zA-Z0-9]{14}$"lgh_Abc123XyZ456De"
The type of object
legal_hold "legal_hold"
The name of the hold, as your admins see it
"X v. Y"
Free text describing the matter, or null
"Preservation notice 2026-08-12"
True when the hold covers every member of your workspace, current and future. Additive with custodian_count — a hold may do both.
false
How many users this hold names individually. Workspace-wide coverage is covers_entire_workspace, not a custodian.
3
When the hold was placed
"2026-09-21T10:00:00Z"
When the hold was released, or null while it is active. A released hold is never deleted.
null

