Method: matters.holds.update
Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.
HTTP request
PUT https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
matterId |
string
The matter ID.
|
holdId |
string
The ID of the hold.
|
Request body
The request body contains an instance of Hold
.
Response body
If successful, the response body contains an instance of Hold
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/ediscovery
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["Updates a hold's scope (organizational unit or accounts) and query parameters, but doesn't allow mixing account and organizational unit scopes within the same hold."],["The endpoint for updating is `PUT https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}` and requires specifying matter and hold IDs."],["The request and response bodies both utilize the `Hold` object for data transfer."],["Authorization necessitates the `https://www.googleapis.com/auth/ediscovery` OAuth scope."]]],["This document outlines the process for updating a hold via a `PUT` request to `https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}`. The request requires `matterId` and `holdId` path parameters. The request body should contain a `Hold` instance. Upon successful update, the response body returns an updated `Hold` instance. The operation supports organizational unit or account scope updates but does not allow mixing both types in a single hold. Authorization requires the `https://www.googleapis.com/auth/ediscovery` OAuth scope.\n"]]