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 will be 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 OAuth 2.0 Overview.