Team Drives-related fields in the Vault API are being replaced. Learn more.

Method: matters.holds.removeHeldAccounts

Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

HTTP request

POST https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
matterId

string

The matter ID.

holdId

string

The hold ID.

Request body

The request body contains data with the following structure:

JSON representation
{
  "accountIds": [
    string
  ]
}
Fields
accountIds[]

string

Account ids to identify HeldAccounts to remove.

Response body

If successful, the response body contains data with the following structure:

Response for batch delete held accounts.

JSON representation
{
  "statuses": [
    {
      object(Status)
    }
  ]
}
Fields
statuses[]

object(Status)

A list of statuses for deleted accounts. Results have the same order as the request.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/ediscovery

Try it!