Method: accounts.emailPreferences.updateEmailPreferences
Stay organized with collections
Save and categorize content based on your preferences.
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):
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-06 UTC.
[null,null,["Last updated 2025-06-06 UTC."],[[["\u003cp\u003eThis operation updates email preferences for a Merchant Center account user, focusing on the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eOnly specified preferences within the \u003ccode\u003eupdateMask\u003c/code\u003e will be modified, leaving others untouched.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ePATCH\u003c/code\u003e call to a specific endpoint with path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequest and response bodies utilize the \u003ccode\u003eEmailPreferences\u003c/code\u003e resource for data exchange.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes updating email preferences for a Merchant Center account user via a PATCH request to `https://merchantapi.googleapis.com/accounts/v1beta/{emailPreferences.name=accounts/*/users/*/emailPreferences}`. The request must include an `updateMask` query parameter specifying which fields to update (e.g., `newsAndTips`). The request body contains the new `EmailPreferences` values. The user should use the `name=accounts/*/users/me/emailPreferences` alias to update their preferences. The `https://www.googleapis.com/auth/content` OAuth scope is required. Successful updates return an instance of `EmailPreferences`.\n"],null,["# Method: accounts.emailPreferences.updateEmailPreferences\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates 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.\n\nPreferences which are not explicitly selected in the update mask will not be updated.\n\nIt is invalid for updates to specify an UNCONFIRMED opt-in status value.\n\nUse the name=accounts/\\*/users/me/emailPreferences alias to update preferences for the authenticated user.\n\n### HTTP request\n\n`PATCH https://merchantapi.googleapis.com/accounts/v1beta/{emailPreferences.name=accounts/*/users/*/emailPreferences}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------|\n| `emailPreferences.name` | `string` Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `newsAndTips` |\n\n### Request body\n\nThe request body contains an instance of [EmailPreferences](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences#EmailPreferences).\n\n### Response body\n\nIf successful, the response body contains an instance of [EmailPreferences](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences#EmailPreferences).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
