---
title: "Update legal hold policy"
method: PUT
path: "/legal_hold_policies/{legal_hold_policy_id}"
tags: ["Legal hold policies"]
---

# Update legal hold policy

`PUT /legal_hold_policies/{legal_hold_policy_id}`

Update legal hold policy.

## Path parameters

- `legal_hold_policy_id` string, required

## Request body

- object
  - `policy_name` string — The name of the policy.
  - `description` string — A description for the policy.
  - `release_notes` string — Notes around why the policy was released.

## Response `200`

Returns a new legal hold policy object.

- LegalHoldPolicy — A mini legal hold policy.
  - `id` string, required — The unique identifier for this legal hold policy.
  - `type` 'legal_hold_policy', required — The value will always be `legal_hold_policy`.
  - `policy_name` string — Name of the legal hold policy.
  - `description` string — 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.
  - `assignment_counts` object — Counts of assignments within a legal hold policy by item type.
    - `user` integer — The number of users this policy is applied to with the `access` type assignment.
    - `folder` integer — The number of folders this policy is applied to.
    - `file` integer — The number of files this policy is applied to.
    - `file_version` integer — The number of file versions this policy is applied to.
    - `ownership` integer — The number of users this policy is applied to with the `ownership` type assignment.
    - `interactions` integer — The number of users this policy is applied to with the `interactions` type assignment.
  - `created_by` object — The user who created the legal hold policy object.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
  - `created_at` string, date-time — When the legal hold policy object was created.
  - `modified_at` string, date-time — When the legal hold policy object was modified. Does not update when assignments are added or removed.
  - `deleted_at` string, 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_at` string, date-time — User-specified, optional date filter applies to Custodian assignments only.
  - `filter_ended_at` string, date-time — User-specified, optional date filter applies to Custodian assignments only.
  - `release_notes` string — Optional notes about why the policy was created.

## Other responses

- `409` — Returns an error if a policy with this name already exists.
- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)