API Reference
Community

Edit Legal Hold

patch
https://api.lucid.co/v1/accounts/me/legalHolds/

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.

📘

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
uuid
required

Unique ID of the legal hold.

Body Params
string

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

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.

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.

string

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

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.

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.

Updated 25 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago

Privacy
Legal
Cookie privacy choices
Cookie policy