Join the first BoxWorks Hackathon for Good - customers, partners, and the developer community are welcome to participate in the 48 hour Hack to benefit The Nature Conservancy.

Learn more and register!

Legal hold policy assignment (Base)

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.


The unique identifier for this legal hold assignment


Value is always legal_hold_policy_assignment

Response Example

  "id": 11446498,
  "type": "legal_hold_policy_assignment"