REST Resource: accounts.emailPreferences
Stay organized with collections
Save and categorize content based on your preferences.
Resource: EmailPreferences
The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
| JSON representation |
{
"name": string,
"newsAndTips": enum (OptInState)
} |
| Fields |
name |
string
Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
|
newsAndTips |
enum (OptInState)
Optional. Updates on new features, tips and best practices.
|
OptInState
Opt in state of the email preference.
| Enums |
OPT_IN_STATE_UNSPECIFIED |
Opt-in status is not specified. |
OPTED_OUT |
User has opted out of receiving this type of email. |
OPTED_IN |
User has opted in to receiving this type of email. |
UNCONFIRMED |
User has opted in to receiving this type of email and the confirmation email has been sent, but user has not yet confirmed the opt in (applies only to certain countries). |
Methods |
|
|
Returns the email preferences for a Merchant Center account user. |
|
|
Updates the email preferences for a Merchant Center account user. |
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-05-27 UTC.
[null,null,["Last updated 2025-05-27 UTC."],[[["\u003cp\u003eThis resource pertains to managing email preferences for Merchant Center account users and does not store persistent data.\u003c/p\u003e\n"],["\u003cp\u003eTwo methods are available: \u003ccode\u003egetEmailPreferences\u003c/code\u003e to retrieve email preferences and \u003ccode\u003eupdateEmailPreferences\u003c/code\u003e to modify them.\u003c/p\u003e\n"]]],["The document outlines methods for managing email preferences within a Merchant Center account. It details two primary actions: retrieving and modifying email preferences. The `getEmailPreferences` method allows users to obtain their current email settings. The `updateEmailPreferences` method enables users to change these settings. The resource itself does not maintain any persistent data.\n"],null,["# REST Resource: accounts.emailPreferences\n\n- [Resource: EmailPreferences](#EmailPreferences)\n - [JSON representation](#EmailPreferences.SCHEMA_REPRESENTATION)\n- [OptInState](#OptInState)\n- [Methods](#METHODS_SUMMARY)\n\nResource: EmailPreferences\n--------------------------\n\nThe categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"newsAndTips\": enum (/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences#OptInState) } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. |\n| `newsAndTips` | `enum (`[OptInState](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences#OptInState)`)` Optional. Updates on new features, tips and best practices. |\n\nOptInState\n----------\n\nOpt in state of the email preference.\n\n| Enums ||\n|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `OPT_IN_STATE_UNSPECIFIED` | Opt-in status is not specified. |\n| `OPTED_OUT` | User has opted out of receiving this type of email. |\n| `OPTED_IN` | User has opted in to receiving this type of email. |\n| `UNCONFIRMED` | User has opted in to receiving this type of email and the confirmation email has been sent, but user has not yet confirmed the opt in (applies only to certain countries). |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| ### [getEmailPreferences](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences/getEmailPreferences) | Returns the email preferences for a Merchant Center account user. |\n| ### [updateEmailPreferences](/merchant/api/reference/rest/accounts_v1beta/accounts.emailPreferences/updateEmailPreferences) | Updates the email preferences for a Merchant Center account user. |"]]
