Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Legal Hold Assignments are used to assign Legal Hold Policies to an item type of: Users, Folders, Files, File Versions, Ownership, or Interactions.

Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity.

​
id
string

The unique identifier for this legal hold assignment.

Example:

"11446498"

​
type
enum<string>

The value will always be legal_hold_policy_assignment.

Available options:
legal_hold_policy_assignment
Example:

"legal_hold_policy_assignment"

​
legal_hold_policy
Legal hold policy (Mini) · object

The policy that the legal hold policy assignment is part of.

​
assigned_to
Legal hold policy item · object

The item that the legal hold policy is assigned to. Includes type and ID.

​
assigned_by
User (Mini) · object

The user who created the legal hold policy assignment.

​
assigned_at
string<date-time>

When the legal hold policy assignment object was created.

Example:

"2012-12-12T10:53:43-08:00"

​
deleted_at
string<date-time>

When the assignment release request was sent. (Because it can take time for an assignment to fully delete, this isn't quite the same time that the assignment is fully deleted). If null, Assignment was not deleted.

Example:

"2012-12-12T10:53:43-08:00"