---
title: "POST /v1/matters/{matterId}/holds/{holdId}/accounts"
method: POST
path: "/v1/matters/{matterId}/holds/{holdId}/accounts"
tags: ["matters"]
---

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

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

## Request

- Base URL: `https://vault.googleapis.com`
- URL: `https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}/accounts`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/ediscovery`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/ediscovery`
- TypeScript: <https://skmtc.dev/google/apis/vault/docs/v1/matters/:matterId/holds/:holdId/accounts/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `matterId` string, required
- `holdId` string, required

## Request body

- HeldAccount: An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
  - `accountId` string: The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  - `email` string: The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  - `firstName` string: Output only. The first name of the account holder.
  - `holdTime` string, google-datetime: Output only. When the account was put on hold.
  - `lastName` string: Output only. The last name of the account holder.

## Response `200`

Successful response

- HeldAccount: An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
  - `accountId` string: The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  - `email` string: The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  - `firstName` string: Output only. The first name of the account holder.
  - `holdTime` string, google-datetime: Output only. When the account was put on hold.
  - `lastName` string: Output only. The last name of the account holder.

## Changes

- **2026-10-10** `ddd37fff1925`: 2 breaking
  - removed the request body
  - removed the media type `*/*` for the response with the status `200`

[Operation history](https://skmtc.dev/google/apis/vault/changes/v1/matters/:matterId/holds/:holdId/accounts/post.md)

---

[API](https://skmtc.dev/google/apis/vault.md) - [All operations](https://skmtc.dev/google/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/vault/revisions/726c68a20360?raw)