---
title: "PUT /gmail/v1/users/{userId}/settings/autoForwarding"
method: PUT
path: "/gmail/v1/users/{userId}/settings/autoForwarding"
tags: ["users"]
---

# PUT /gmail/v1/users/{userId}/settings/autoForwarding

`PUT /gmail/v1/users/{userId}/settings/autoForwarding`

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. For more information, see [Manage email forwarding](https://developers.google.com/workspace/gmail/api/guides/forwarding_settings). This method is only available to service account clients that have been delegated domain-wide authority.

## Path parameters

- `userId` string, required

## Request body

- AutoForwarding — Auto-forwarding settings for an account.
  - `disposition` 'dispositionUnspecified' | 'leaveInInbox' | 'archive' | 'trash' | 'markRead' — The state that a message should be left in after it has been forwarded.
  - `enabled` boolean — Whether all incoming mail is automatically forwarded to another address.
  - `emailAddress` string — Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/gmail.md) · [All operations](https://skmtc.net/google/apis/gmail/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/gmail/versions/913c74ffe246/schema)