Sample - Box Platform API
POST/legal_hold_policy_assignments

Assign legal hold policy

Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 body fields
policy_idstringrequired
The ID of the policy to assign.
assign_toobjectrequired
The item to assign the policy to.

2 status codes
201Returns a new legal hold policy assignment.
idstringoptional
The unique identifier for this legal hold assignment.
typestringoptional
The value will always be `legal_hold_policy_assignment`.
Allowed:legal_hold_policy_assignment
legal_hold_policyobjectoptional
assigned_toobjectoptional
assigned_byobjectoptional
assigned_atstringoptional
When the legal hold policy assignment object was created.
deleted_atstringoptional
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.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.