- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- AddHeldAccountResult
- Try it!
Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added 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 |
The matter ID. |
holdId |
The hold ID. |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "emails": [ string ], "accountIds": [ string ] } |
Fields | |
---|---|
emails[] |
Emails to identify which accounts to add. Only emails or only accountIds should be specified, but not both. |
accountIds[] |
Account IDs to identify which accounts to add. Only accountIds or only emails should be specified, 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 ( |
Fields | |
---|---|
responses[] |
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
A status detailing the status of each account creation, and the HeldAccount, if successful.
JSON representation | |
---|---|
{ "account": { object ( |
Fields | |
---|---|
account |
If present, this account was successfully created. |
status |
This represents the success status. If failed, check message. |