Release Legal Hold Device

Submit a request to release an asset from active legal hold status.

POST

/legal-hold/active

Description

The Release Legal Hold Device API allows you to submit a request to release an asset from active legal hold status. This endpoint creates a release request ticket and checks for any existing tickets associated with the device. Once approved, the device can be returned to deployable status and normal operations.

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 release request
description	string	Yes	Reason for releasing the device from legal hold
user	object	Yes	Device object containing legal hold information
user.id	number	Yes	Legal hold record ID
user.serial_number	string	Yes	Device serial number
user.status_name	string	Yes	Current status of the device (should be "Legal Hold")

Response

Response Fields

Field	Type	Description
success	boolean	Indicates whether the request was successful
ticket_exists	boolean	Indicates if a release ticket already exists for this device
message	string	Status message describing the result
ticketId	string	The unique identifier for the release ticket
ticketNumber	string	The human-readable ticket number for tracking
existingSerialNumbers	string	Serial numbers with existing tickets (only present if ticket_exists is true)

Error Responses

Common error responses you may encounter when using this endpoint.

Notes

The API checks if a release ticket already exists for the specified device before creating a new one.
If a ticket already exists, the response will include ticket_exists: true and provide the existing ticket details.
Release requests typically require approval before the legal hold is removed from the device.
All release requests are logged with timestamps and requestor information for compliance and audit purposes.
The user.id should correspond to the legal hold record ID, not the asset ID.
Ensure the device status_name is "Legal Hold" before attempting to release it.
Once approved, the device can be returned to deployable status and normal operations.

Related Endpoints

View Active Holds

Retrieve a paginated list of all assets currently under active legal hold

Submit Legal Hold

Submit a request to place multiple devices on legal hold

Did this page help you?

Request Example

curl -X POST https://dev-api.unduit.com/legal-hold/active \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "summary": "Transfer Device(s)",
    "description": "Release from legal hold",
    "user": {
      "id": 56,
      "serial_number": "9856327472",
      "status_name": "Legal Hold"
    }
  }'

Success Response (200)

{
  "success": true,
  "ticket_exists": false,
  "message": "Release request created successfully",
  "ticketId": "695cc7ff65c128d0fc486492",
  "ticketNumber": "1002183"
}

Ticket Already Exists (200)

{
  "success": true,
  "ticket_exists": true,
  "message": "A ticket already exists for these device(s)",
  "ticketId": "695cc7ff65c128d0fc486492",
  "ticketNumber": "1002183",
  "existingSerialNumbers": "9856327472"
}

Error Responses

400 Bad Request

{
  "success": false,
  "message": "Missing required fields: summary, description"
}

401 Unauthorized

{
  "success": false,
  "message": "Invalid or missing authentication token"
}

404 Not Found

{
  "success": false,
  "message": "Legal hold record not found with ID: 56"
}

422 Unprocessable Entity

{
  "success": false,
  "message": "Device is not currently on legal hold"
}