Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
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.

post/legal_hold_policy_assignments

Request body

policy_idstring required

The ID of the policy to assign.

Example request

{
  "policy_id": "123244",
  "assign_to": {
    "type": "folder",
    "id": "6564564"
  }
}

Response

Returns a new legal hold policy assignment.

idstring

The unique identifier for this legal hold assignment.

type'legal_hold_policy_assignment'

The value will always be legal_hold_policy_assignment.

assigned_atstring date-time

When the legal hold policy assignment object was created.

deleted_atstring 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 response

{
  "id": "11446498",
  "type": "legal_hold_policy_assignment",
  "legal_hold_policy": {
    "id": "11446498",
    "type": "legal_hold_policy"
  },
  "assigned_to": {
    "type": "folder",
    "id": "6564564"
  },
  "assigned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "deleted_at": "2012-12-12T10:53:43-08:00"
}