Method: accounts.emailPreferences.updateEmailPreferences

  • This operation updates email preferences for a Merchant Center account user, focusing on the authenticated user.

  • Only specified preferences within the updateMask will be modified, leaving others untouched.

  • The request requires a PATCH call to a specific endpoint with path and query parameters.

  • Request and response bodies utilize the EmailPreferences resource for data exchange.

  • Authorization requires the https://www.googleapis.com/auth/content scope.

Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account.

Preferences which are not explicitly selected in the update mask will not be updated.

It is invalid for updates to specify an UNCONFIRMED opt-in status value.

Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

HTTP request

PATCH https://merchantapi.googleapis.com/accounts/v1beta/{emailPreferences.name=accounts/*/users/*/emailPreferences}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
emailPreferences.name

string

Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

  • newsAndTips

Request body

The request body contains an instance of EmailPreferences.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.