GOgoogle
matters

POST /v1/matters/{matterId}/holds/{holdId}/accounts

Changed on

Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.

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

accountIdstring

The account ID, as provided by the Admin SDK.

emailstring

The primary email address of the account. If used as an input, this takes precedence over accountId.

firstNamestring

Output only. The first name of the account holder.

holdTimestring google-datetime

Output only. When the account was put on hold.

lastNamestring

Output only. The last name of the account holder.

Response

Successful response

accountIdstring

The account ID, as provided by the Admin SDK.

emailstring

The primary email address of the account. If used as an input, this takes precedence over accountId.

firstNamestring

Output only. The first name of the account holder.

holdTimestring google-datetime

Output only. When the account was put on hold.

lastNamestring

Output only. The last name of the account holder.

Changes

  • ddd37fff1925Revision changes
    • breaking

      removed the request body

    • breaking

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