Edit Legal Hold

patch https://api.lucid.co/accounts/me/legalHolds/{legalHoldId}

📘
This API is exclusive to Enterprise Shield accounts
Only the account owner or a document admin can grant access to this API.

Modifies the legal hold specified by the legalHoldId.

If the legal hold has not yet ended, the name, description, and end time may be modified.
If the legal hold has not yet started, the start time and keywords may also be modified.

Valid Authentication Methods

API Key Grants:

LegalHoldEdit

OAuth 2.0 User Token Scopes

account.legalhold

Path Params

legalHoldId

uuid

required

Unique ID of the legal hold.

Body Params

Title

string

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

StartTime

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.

EndTime

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.

Description

string

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

Keywords

string

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.

Headers

Lucid-Api-Version

string

required

Defaults to 1

The API version used in the request.

Responses

400

Incorrect format or invalid parameters.

403

Account does not have permission to access the API.

404

The specified legal hold id was not found.

Language

Credentials


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.lucid.co/accounts/me/legalHolds/legalHoldId \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'


xxxxxxxxxx
11
 
1
{
2
  "LegalHoldId": "110808fd-4553-4316-bccf-4f25ff59a532",
3
  "AccountId": 100,
4
  "StartTime": "2025-01-01T16:18:26Z",
5
  "EndTime": "2025-12-01T16:18:26Z",
6
  "Title": "New Legal Hold",
7
  "Description": "Legal hold example",
8
  "Keywords": "alpha",
9
  "Created": "2024-12-01T16:25:44Z",
10
  "Modified": "2024-12-01T16:25:44Z"
11
}

📘This API is exclusive to Enterprise Shield accounts

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes

200With the legal hold that was successfully modified.

📘
This API is exclusive to Enterprise Shield accounts