Submit Legal Hold Request
Submit a request to place multiple devices on legal hold for litigation or regulatory compliance.
POST
/legal-hold/submitDescription
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
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <token> | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| summary | string | Yes | Brief title for the legal hold request |
| description | string | Yes | Detailed description of the legal hold reason |
| users | array | Yes | Array of user objects with device information to place on hold |
| users[].serialNumber | string | Yes | Device serial number |
| users[].name | string | Yes | Name of the person associated with the device |
| users[].email | string | Yes | Email address of the person associated with the device |
| users[].recoveryNumber | string | Yes | Recovery tracking number for the device |
| users[].assetName | string | Yes | Name or identifier for the asset |
| users[].assetId | string | Yes | Asset model or identifier (e.g., "Dell Latitude 5520") |
Response
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful |
| ticketNumber | string | The generated support ticket number for tracking |
| ticketId | string | The 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?
Request Example
curl -X POST https://dev-api.unduit.com/legal-hold/submit \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"summary": "Legal hold request for litigation case",
"description": "Please place the following devices on legal hold",
"users": [
{
"serialNumber": "LION-2-12-001",
"name": "John Doe",
"email": "john.doe@company.com",
"recoveryNumber": "REC001",
"assetName": "Laptop",
"assetId": "Dell Latitude 5520"
}
]
}'Success Response (200)
{
"success": true,
"ticketNumber": "1002254",
"ticketId": "6965ebcf4ec17779760569b8"
}Error Responses
400 Bad Request
{
"success": false,
"message": "Missing required fields: summary, description, users"
}401 Unauthorized
{
"success": false,
"message": "Invalid or missing authentication token"
}409 Conflict
{
"success": false,
"message": "Legal hold already exists for device with serial number: LION-2-12-001"
}422 Unprocessable Entity
{
"success": false,
"message": "Invalid email format in users array"
}