Users.settings.delegates: create

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 G Suite organization as the delegator user.

Gmail imposes limtations 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.

Request

HTTP request

POST https://www.googleapis.com/gmail/v1/users/userId/settings/delegates

Parameters

Parameter name Value Description
Path parameters
userId string User's email address. The special value "me" can be used to indicate the authenticated user.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/gmail.settings.sharing

For more information, see the authentication and authorization page.

Request body

In the request body, supply a Users.settings.delegates resource.

Response

If successful, this method returns a Users.settings.delegates resource in the response body.