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

Method: matters.holds.addHeldAccounts

Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.

HTTP request

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

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 
{
  "emails": [
    string
  ],
  "accountIds": [
    string
  ]
}
Fields
emails[]

string

A comma-separated list of the emails of the accounts to add to the hold. Specify either emails or accountIds, but not both.
accountIds[]

string

A comma-separated list of the account IDs of the accounts to add to the hold. Specify either emails or accountIds, but not both.

Response body

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

Response for batch create held accounts.

JSON representation 
{
  "responses": [
    {
      object (AddHeldAccountResult)
    }
  ]
}
Fields
responses[]

object (AddHeldAccountResult)

The list of responses, in the same order as the batch request.

Authorization Scopes

Requires the following OAuth scope:

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

AddHeldAccountResult

The status of each account creation, and the HeldAccount, if successful.

JSON representation 
{
  "account": {
    object (HeldAccount)
  },
  "status": {
    object (Status)
  }
}
Fields
account

object (HeldAccount)

Returned when the account was successfully created.
status

object (Status)

Reports the request status. If it failed, returns an error message.