Add Legal Hold Users

📘

This API is exclusive to Enterprise Shield accounts

Only the account owner or a document admin can grant access to this API.

Adds users to the legal hold specified by the legalHoldId.

  • This action can only be performed for legal holds that have not started yet.

Valid Authentication Methods

API Key Grants:

  • LegalHoldEdit

OAuth 2.0 User Token Scopes:

  • account.legalhold
  • account.legalhold.users

Path Params
uuid
required
Body Params
Users
array of numbers
required
Users*
Headers
string
required
Defaults to 1
Responses
204

Users were correctly added to the legal hold.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here!