Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Legal Holds

Create Legal Hold

Creates a new legal hold on an Enterprise Shield account with specified parameters including title, description, keywords, and start/end times.

post/v1/accounts/me/legalHolds

Request body

Titlestring required

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

StartTimestring date-time required

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

EndTimestring 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.

Descriptionstring

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

Keywordsstring

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.

Response

With the newly created legal hold.

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"
}