Create legal hold policy
Create a new legal hold policy.
Request
Request Body
"A custom policy for the sales team"500A description for the policy.
"2012-12-18T10:53:43-08:00"500The 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.
"2012-12-12T10:53:43-08:00"500The 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.
trueWhether 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.
"Sales Policy"254The name of the policy.
Response
Returns a new legal hold policy object.
Returns an error if required parameters are missing,
or neither is_ongoing or filter dates are specified.
Returns an error if a policy with this name already exists.
An unexpected client error.
Request Example
curl -i -X POST "https://api.box.com/2.0/legal_hold_policies" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"policy_name": "Policy 3",
"description": "Automatic created policy"
}'await client.legalHoldPolicies.createLegalHoldPolicy({
policyName: legalHoldPolicyName,
description: legalHoldDescription,
isOngoing: false,
filterStartedAt: filterStartedAt,
filterEndedAt: filterEndedAt,
} satisfies CreateLegalHoldPolicyRequestBody);client.legal_hold_policies.create_legal_hold_policy(
legal_hold_policy_name,
description=legal_hold_description,
filter_started_at=filter_started_at,
filter_ended_at=filter_ended_at,
is_ongoing=False,
)await client.LegalHoldPolicies.CreateLegalHoldPolicyAsync(requestBody: new CreateLegalHoldPolicyRequestBody(policyName: legalHoldPolicyName) { Description = legalHoldDescription, IsOngoing = false, FilterStartedAt = filterStartedAt, FilterEndedAt = filterEndedAt });BoxLegalHoldPolicy.Info policyInfo = BoxLegalHoldPolicy.create(api, name, description, startedAt, endedAt);new_policy = client.create_legal_hold_policy('New Policy', is_ongoing=True)
print(f'Created legal hold policy with ID {new_policy.id}')var policyParams = new BoxLegalHoldPolicyRequest()
{
PolicyName = "IRS Audit"
};
BoxLegalHoldPolicy policy = await client.LegalHoldPoliciesManager
.CreateLegalHoldPolicyAsync(policyParams);client.legalHoldPolicies.create('IRS Audit')
.then(policy => {
/* policy -> {
type: 'legal_hold_policy',
id: '11111',
policy_name: 'IRS Audit',
description: '',
status: 'active',
assignment_counts: { user: 0, folder: 0, file: 0, file_version: 0 },
is_ongoing: true,
created_by:
{ type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com' },
created_at: '2017-01-24T16:57:22-08:00',
modified_at: '2017-01-24T16:57:22-08:00',
deleted_at: null,
filter_started_at: null,
filter_ended_at: null }
*/
});client.legalHolds.create(name: "New Folder") { (result: Result<LegalHoldPolicy, BoxSDKError>) in
guard case let .success(policy) = result else {
print("Error creating legal hold policy")
return
}
print("Created legal hold policy \"\(policy.name)\"")
}Response Example
{
"id": "11446498",
"type": "legal_hold_policy",
"assignment_counts": {
"file": 3,
"file_version": 4,
"folder": 2,
"user": 1
},
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"deleted_at": "2012-12-12T10:53:43-08:00",
"description": "Postman created policy",
"filter_ended_at": "2012-12-12T10:53:43-08:00",
"filter_started_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Policy 4",
"release_notes": "Example",
"status": "active"
}