Submit Legal Hold Request

Submit a request to place multiple devices on legal hold for litigation or regulatory compliance.

POST
/legal-hold/submit

Description

The Submit Legal Hold Request API enables organizations to place multiple devices on legal hold in a single request. When devices are placed on legal hold, they are marked as undeployable and cannot be disposed of, wiped, or redeployed until the hold is released. A support ticket is automatically created to track the legal hold request and maintain an audit trail.

Request

Headers

HeaderValueRequired
AuthorizationBearer <token>Yes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
summarystringYesBrief title for the legal hold request
descriptionstringYesDetailed description of the legal hold reason
usersarrayYesArray of user objects with device information to place on hold
users[].serialNumberstringYesDevice serial number
users[].namestringYesName of the person associated with the device
users[].emailstringYesEmail address of the person associated with the device
users[].recoveryNumberstringYesRecovery tracking number for the device
users[].assetNamestringYesName or identifier for the asset
users[].assetIdstringYesAsset model or identifier (e.g., "Dell Latitude 5520")

Response

Response Fields

FieldTypeDescription
successbooleanIndicates whether the request was successful
ticketNumberstringThe generated support ticket number for tracking
ticketIdstringThe unique identifier for the created support ticket

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

  • A support ticket is automatically created for each legal hold request to track the request through the approval workflow.
  • Devices are immediately marked with "Legal Hold" status and become undeployable once the request is processed.
  • You can include multiple devices in a single request for efficient bulk legal hold placement.
  • All legal hold placements are logged with timestamps and requestor information for compliance and audit purposes.
  • Ensure all required fields in the users array are provided to avoid validation errors.
  • Email addresses must be valid format and serial numbers must exist in the system.
  • Duplicate legal hold requests for the same device will return a 409 Conflict error.

Related Endpoints

Did this page help you?