GOgoogle
matters

POST /v1/matters/{matterId}/holds/{holdId}:addHeldAccounts

Changed on

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.

Request

  • Base URL
    https://vault.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/ediscovery
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/ediscovery
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

matterIdstring required

The matter ID.

holdIdstring required

The hold ID.

Request body

accountIdsstring[]

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

emailsstring[]

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

Response

Successful response

Changes

  • ddd37fff1925Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status