Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Legal hold policy assignment (Base)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions.

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

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

string
11446498

The unique identifier for this legal hold assignment.

string
legal_hold_policy_assignment

The value will always be legal_hold_policy_assignment.

Value is always legal_hold_policy_assignment

Response Example

{
  "id": "11446498",
  "type": "legal_hold_policy_assignment"
}