GRgranola

Update legal hold

Changed on

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.

patch/v1/legal-holds/{hold_id}

Request

  • Base URL
    https://public-api.granola.ai
  • Auth
    HTTP bearer

Path parameters

hold_idstring required

The legal hold id. Case-insensitive.

Example:lgh_Abc123XyZ456De

Request body

namestring

A new name for the matter

descriptionstring nullable

New free text for the matter, or null to clear it

covers_entire_workspaceboolean

Whether the hold covers every member of your workspace. Toggling this never touches the custodians the hold names.

Example request

{
  "name": "X v. Y (consolidated)",
  "description": "Preservation notice 2026-08-12",
  "covers_entire_workspace": true
}

Response

The updated legal hold

idstring required

The unique identifier for the legal hold

object'legal_hold' required

The type of object

namestring required

The name of the hold, as your admins see it

descriptionstring nullable required

Free text describing the matter, or null

covers_entire_workspaceboolean required

True when the hold covers every member of your workspace, current and future. Additive with custodian_count — a hold may do both.

custodian_countinteger required

How many users this hold names individually. Workspace-wide coverage is covers_entire_workspace, not a custodian.

created_atstring date-time required

When the hold was placed

released_atstring date-time nullable required

When the hold was released, or null while it is active. A released hold is never deleted.

Example response

{
  "id": "lgh_Abc123XyZ456De",
  "object": "legal_hold",
  "name": "X v. Y",
  "description": "Preservation notice 2026-08-12",
  "custodian_count": 3,
  "created_at": "2026-09-21T10:00:00Z"
}

Changes