REST Resource: users.settings.delegates
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Delegate
Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
| JSON representation |
{
"delegateEmail": string,
"verificationStatus": enum (VerificationStatus)
} |
| Fields |
delegateEmail |
string
The email address of the delegate.
|
verificationStatus |
enum (VerificationStatus)
Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
|
VerificationStatus
Indicates whether ownership of an email address has been verified for delegation use.
| Enums |
verificationStatusUnspecified |
Unspecified verification status. |
accepted |
The address can act a delegate for the account. |
pending |
A verification request was mailed to the address, and the owner has not yet accepted it. |
rejected |
A verification request was mailed to the address, and the owner rejected it. |
expired |
A verification request was mailed to the address, and it expired without verification. |
Methods |
|
|
Adds a delegate with its verification status set directly to accepted, without sending any verification email. |
|
|
Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. |
|
|
Gets the specified delegate. |
|
|
Lists the delegates for the specified account. |
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-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# REST Resource: users.settings.delegates\n\n- [Resource: Delegate](#Delegate)\n - [JSON representation](#Delegate.SCHEMA_REPRESENTATION)\n- [VerificationStatus](#VerificationStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Delegate\n------------------\n\nSettings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See [\"Set up mail delegation\"](https://support.google.com/mail/answer/138350) for more information about delegates.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"delegateEmail\": string, \"verificationStatus\": enum (/workspace/gmail/api/reference/rest/v1/users.settings.delegates#VerificationStatus) } ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `delegateEmail` | `string` The email address of the delegate. |\n| `verificationStatus` | `enum (`[VerificationStatus](/workspace/gmail/api/reference/rest/v1/users.settings.delegates#VerificationStatus)`)` Indicates whether this address has been verified and can act as a delegate for the account. Read-only. |\n\nVerificationStatus\n------------------\n\nIndicates whether ownership of an email address has been verified for delegation use.\n\n| Enums ||\n|---------------------------------|------------------------------------------------------------------------------------------|\n| `verificationStatusUnspecified` | Unspecified verification status. |\n| `accepted` | The address can act a delegate for the account. |\n| `pending` | A verification request was mailed to the address, and the owner has not yet accepted it. |\n| `rejected` | A verification request was mailed to the address, and the owner rejected it. |\n| `expired` | A verification request was mailed to the address, and it expired without verification. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [create](/workspace/gmail/api/reference/rest/v1/users.settings.delegates/create) | Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. |\n| ### [delete](/workspace/gmail/api/reference/rest/v1/users.settings.delegates/delete) | Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. |\n| ### [get](/workspace/gmail/api/reference/rest/v1/users.settings.delegates/get) | Gets the specified delegate. |\n| ### [list](/workspace/gmail/api/reference/rest/v1/users.settings.delegates/list) | Lists the delegates for the specified account. |"]]
