Skip to main content

delegates

Overview

Namedelegates
TypeResource
Idgoogleworkspace.gmail.delegates

Fields

NameDatatypeDescription
verificationStatusstringIndicates whether this address has been verified and can act as a delegate for the account. Read-only.
delegateEmailstringThe email address of the delegate.

Methods

NameAccessible byRequired ParamsDescription
users_settings_delegates_getSELECTdelegateEmail, userIdGets the specified delegate. Note that 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.
users_settings_delegates_listSELECTuserIdLists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
users_settings_delegates_createINSERTuserIdAdds 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 G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite 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. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that 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.
users_settings_delegates_deleteDELETEdelegateEmail, userIdRemoves the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that 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.