Create Legal Hold

post https://api.lucid.co/accounts/me/legalHolds

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

Creates a new legal hold on the account, with the specified parameters.

On creation, the admin can define the title, description, keywords, and start/end times.

Valid Authentication Methods

API Key Grants:

LegalHoldEdit

OAuth 2.0 User Token Scopes

account.legalhold

Body Params

Title

string

required

Title that should be given to the newly created legal hold. Max length of title is 80 characters.

StartTime

date-time

required

Time that the legal hold should start. Must not be in the past.

EndTime

date-time

required

Time that the legal hold should end. End time must be greater than or equal to 24 hours after the start time.

Description

string

Description that should be given to the newly created legal hold. Max length of description is 256 characters.

Keywords

string

Keyword(s) to search against document content and titles. Note: When provided, only relevant results will be added to the legal hold. Empty strings will be treated the same as when no keywords are provided. Max length of keywords is 400 characters.

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.

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lucid.co/accounts/me/legalHolds \
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

201With the newly created legal hold.

📘
This API is exclusive to Enterprise Shield accounts