Method: users.settings.updateAutoForwarding

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

This method is only available to service account clients that have been delegated domain-wide authority.

HTTP request

PUT https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding

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 AutoForwarding.

Response body

If successful, the response body contains an instance of AutoForwarding.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.