Method: users.stop
users.stop receiving push notifications for the given user mailbox.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/stop
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
The user's email address. The special value me can be used to indicate the authenticated user.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires one of the following OAuth scopes:
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
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."],[[["Stops users from receiving push notifications for a given user mailbox."],["Uses an HTTP POST request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/stop`."],["Requires the `userId` path parameter, representing the user's email address."],["Needs authorization with specific OAuth scopes like `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify`."],["An empty request body is required, and a successful response results in an empty response body."]]],["This outlines how to stop a user from receiving push notifications via a POST request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/stop`. The `userId`, representing the user's email or 'me', is a required path parameter. The request body must be empty. A successful request results in an empty response body. Authorization requires one of four specific OAuth scopes, such as `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.modify`.\n"]]
