Google: Gmail users settings delegates schemas
3 Google schemas with complete fields and constraints.
← Gmail users settings delegates operations · All schemas
Adds a delegate with its verification status set directly to `accepted`, without sending any verification email The delegate user must be a member of the same Google Workspace organization as the delegator user For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) Gmail imposes limitations on the number of delegates and delegators each user in a Google Workspace organization can have These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators A delegate user must be referred to by their primary email address, and not an email alias When a new delegate is created, there may be up to a one minute delay before the new delegate is available for use This method is only available to service account clients that have been delegated domain-wide authority — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
delegateEmail | string | Optional | The email address of the delegate. |
verificationStatus | string | Optional | Indicates whether this address has been verified and can act as a delegate for the account. Read-only. One of: verificationStatusUnspecified, accepted, pending, rejected, expired |
Gets the specified delegate For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) A delegate user must be referred to by their primary email address, and not an email alias This method is only available to service account clients that have been delegated domain-wide authority — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
delegateEmail | string | Optional | The email address of the delegate. |
verificationStatus | string | Optional | Indicates whether this address has been verified and can act as a delegate for the account. Read-only. Known values: verificationStatusUnspecified, accepted, pending, rejected, expired |
Lists the delegates for the specified account For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) This method is only available to service account clients that have been delegated domain-wide authority — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for the ListDelegates method. |
delegates | array | Optional | List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear. |
delegates[] | Model | Each item | Expand Gets the specified delegate For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) A delegate user must be referred to by their primary email address, and not an email alias This method is only available to service account clients that have been delegated domain-wide authority — response body |