Method: matters.addPermissions
Stay organized with collections
Save and categorize content based on your preferences.
Adds an account as a matter collaborator.
HTTP request
POST https://vault.googleapis.com/v1/matters/{matterId}:addPermissions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
matterId |
string
The matter ID.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"matterPermission": {
object (MatterPermission)
},
"sendEmails": boolean,
"ccMe": boolean
} |
| Fields |
matterPermission |
object (MatterPermission)
The account and its role to add.
|
sendEmails |
boolean
To send a notification email to the added account, set to true. To not send a notification email, set to false.
|
ccMe |
boolean
Only relevant if sendEmails is true. To CC the requestor in the email message, set to true. To not CC requestor, set to false.
|
Response body
If successful, the response body contains an instance of MatterPermission.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/ediscovery
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-17 UTC.
[null,null,["Last updated 2025-03-17 UTC."],[],[],null,["# Method: matters.addPermissions\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAdds an account as a matter collaborator.\n\n### HTTP request\n\n`POST https://vault.googleapis.com/v1/matters/{matterId}:addPermissions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------|\n| `matterId` | `string` The matter ID. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"matterPermission\": { object (/workspace/vault/reference/rest/v1/matters#MatterPermission) }, \"sendEmails\": boolean, \"ccMe\": boolean } ``` |\n\n| Fields ||\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matterPermission` | `object (`[MatterPermission](/workspace/vault/reference/rest/v1/matters#MatterPermission)`)` The account and its role to add. |\n| `sendEmails` | `boolean` To send a notification email to the added account, set to **true** . To not send a notification email, set to **false**. |\n| `ccMe` | `boolean` Only relevant if **sendEmails** is **true** . To CC the requestor in the email message, set to **true** . To not CC requestor, set to **false**. |\n\n### Response body\n\nIf successful, the response body contains an instance of [MatterPermission](/workspace/vault/reference/rest/v1/matters#MatterPermission).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
