Method: 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.
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.
HTTP request
DELETE https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
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.
|
delegateEmail |
string
The email address of the user to be removed as a delegate.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Removes a delegate user identified by their primary email address, revoking any associated verification."],["This action is restricted to service account clients with delegated domain-wide authority."],["The request must specify the user and delegate's email addresses as path parameters."],["A successful operation results in an empty response body, indicating the delegate was removed."],["This functionality requires the `https://www.googleapis.com/auth/gmail.settings.sharing` OAuth scope for authorization."]]],["This outlines how to remove a delegate from a user's Gmail account. A `DELETE` HTTP request is sent to a specific URL, including the user's email (`userId`) and the delegate's email (`delegateEmail`) as path parameters. The request body must be empty. A successful removal returns an empty response body. This operation is only available to service accounts with domain-wide authority, and it requires the `gmail.settings.sharing` authorization scope. Only primary email address can be used for the delegate.\n"]]
