Method: users.settings.delegates.create
Stay organized with collections
Save and categorize content based on your preferences.
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.
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.
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.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
User's email address. The special value "me" can be used to indicate the authenticated user.
|
Request body
The request body contains an instance of Delegate.
Response body
If successful, the response body contains a newly created instance of Delegate.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/gmail.settings.sharing
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-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# Method: users.settings.delegates.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nAdds 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.\n\nGmail 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.\n\nNote that a delegate user must be referred to by their primary email address, and not an email alias.\n\nAlso 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.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.\n\n### HTTP request\n\n`POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------|\n| `userId` | `string` User's email address. The special value \"me\" can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body contains an instance of [Delegate](/workspace/gmail/api/reference/rest/v1/users.settings.delegates#Delegate).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Delegate](/workspace/gmail/api/reference/rest/v1/users.settings.delegates#Delegate).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
