Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Legal Holds

Edit Legal Hold

Modifies an existing legal hold, allowing changes to the title, description, and end time. If the legal hold has not yet started, the start time and keywords can also be updated.

patch/v1/accounts/me/legalHolds/{legalHoldId}

Path parameters

legalHoldIdstring uuid required

Unique ID of the legal hold.

Request body

Titlestring

The new title for the legal hold (the existing one will be replaced). Max length of title is 80 characters.

StartTimestring date-time

The new time that the legal hold will begin. Must be at least 24 hours before the end time and cannot be in the past. Cannot be changed if the legal hold has already started.

EndTimestring date-time

The new time that the legal hold will end and documents on the legal hold will be released. Must be at least 24 hours after the start time and cannot be in the past.

Descriptionstring

The new description for the legal hold (the existing one will be replaced). Max length of description is 256 characters.

Keywordsstring

The new keywords for the legal hold (any existing ones will be replaced). Max length of keywords is 400 characters. Cannot be changed if the legal hold has already started.

Response

With the legal hold that was successfully modified.

LegalHoldIdstring uuid required

Unique ID of the legal hold.

AccountIdnumber required

Unique ID for the creating admin’s account.

StartTimestring date-time required

Start time of the legal hold.

EndTimestring date-time required

End time of the legal hold.

Titlestring required

Title of the legal hold.

Descriptionstring

Description of the legal hold.

Keywordsstring

Keyword(s) of the legal hold.

Createdstring date-time required

Time that the legal hold was created.

Modifiedstring date-time required

Time that the legal hold was last modified.

Example response

{
  "LegalHoldId": "110808fd-4553-4316-bccf-4f25ff59a532",
  "AccountId": 100,
  "StartTime": "2025-01-01T16:18:26Z",
  "EndTime": "2025-12-01T16:18:26Z",
  "Title": "New Legal Hold",
  "Description": "Legal hold example",
  "Keywords": "alpha",
  "Created": "2024-12-01T16:25:44Z",
  "Modified": "2024-12-01T16:25:44Z"
}