Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Legal hold policies

Create legal hold policy

Create a new legal hold policy.

post/legal_hold_policies

Request body

policy_namestring required

The name of the policy.

descriptionstring

A description for the policy.

filter_started_atstring date-time

The filter start date.

When this policy is applied using a custodian legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.

Required if is_ongoing is set to false.

filter_ended_atstring date-time

The filter end date.

When this policy is applied using a custodian legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.

Required if is_ongoing is set to false.

is_ongoingboolean

Whether new assignments under this policy should continue applying to files even after initialization.

When this policy is applied using a legal hold assignment, it will continue applying the policy to any new file versions even after it has been applied.

For example, if a legal hold assignment is placed on a user today, and that user uploads a file tomorrow, that file will get held. This will continue until the policy is retired.

Required if no filter dates are set.

Example request

{
  "policy_name": "Sales Policy",
  "description": "A custom policy for the sales team",
  "filter_started_at": "2012-12-12T10:53:43-08:00",
  "filter_ended_at": "2012-12-18T10:53:43-08:00",
  "is_ongoing": true
}

Response

Returns a new legal hold policy object.

idstring required

The unique identifier for this legal hold policy.

type'legal_hold_policy' required

The value will always be legal_hold_policy.

policy_namestring

Name of the legal hold policy.

descriptionstring

Description of the legal hold policy. Optional property with a 500 character limit.

status'active' | 'applying' | 'releasing' | 'released'

Possible values:

  • 'active' - the policy is not in a transition state.
  • 'applying' - that the policy is in the process of being applied.
  • 'releasing' - that the process is in the process of being released.
  • 'released' - the policy is no longer active.
created_atstring date-time

When the legal hold policy object was created.

modified_atstring date-time

When the legal hold policy object was modified. Does not update when assignments are added or removed.

deleted_atstring date-time

When the policy release request was sent. (Because it can take time for a policy to fully delete, this isn't quite the same time that the policy is fully deleted).

If null, the policy was not deleted.

filter_started_atstring date-time

User-specified, optional date filter applies to Custodian assignments only.

filter_ended_atstring date-time

User-specified, optional date filter applies to Custodian assignments only.

release_notesstring

Optional notes about why the policy was created.

Example response

{
  "id": "11446498",
  "type": "legal_hold_policy",
  "policy_name": "Policy 4",
  "description": "Postman created policy",
  "status": "active",
  "assignment_counts": {
    "user": 1,
    "folder": 2,
    "file": 3,
    "file_version": 4,
    "ownership": 5,
    "interactions": 6
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "deleted_at": "2012-12-12T10:53:43-08:00",
  "filter_started_at": "2012-12-12T10:53:43-08:00",
  "filter_ended_at": "2012-12-12T10:53:43-08:00",
  "release_notes": "Example"
}