Skip to content

Google: 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 — request body — body

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.: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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 — request body — body

FieldTypePresenceDescription and constraints
$objectRootAuto-forwarding settings for an account.
dispositionstringOptionalThe state that a message should be left in after it has been forwarded.
One of: dispositionUnspecified, leaveInInbox, archive, trash, markRead
emailAddressstringOptionalEmail address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
enabledbooleanOptionalWhether all incoming mail is automatically forwarded to another address.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.