| title | Update legalHold |
|---|---|
| description | Update the properties of a legalHold object. |
| ms.localizationpriority | medium |
| author | mahage-msft |
| ms.subservice | ediscovery |
| doc_type | apiPageType |
| ms.date | 06/25/2024 |
Namespace: microsoft.graph.ediscovery
[!INCLUDE beta-disclaimer]
[!INCLUDE ediscovery-deprecation]
Update the properties of a legalHold object.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
PATCH /compliance/ediscovery/cases/{caseId}/legalHolds/{legalholdId}| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Content-Type | application/json. Required. |
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.
| Property | Type | Description |
|---|---|---|
| description | String | The legal hold description. |
| displayName | String | The display name of the legal hold. |
| isEnabled | Boolean | Indicates whether the hold is enabled and actively holding content. |
If successful, this action returns a 204 No Content response code.
PATCH https://graph.microsoft.com/beta/compliance/ediscovery/cases/{caseId}/legalHolds/{legalholdId}
Content-Type: application/json
{
"description": "This is a description for a legalHold"
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
HTTP/1.1 204 No Content