Stay organized with collections
Save and categorize content based on your preferences.
This guide explains how to use the
patch()
method on the SpaceNotificationSetting resource of the Google Chat API to update
a user's space notification settings.
The
SpaceNotificationSetting resource
is a singleton resource that represents details about a specified user's space
notification settings.
Create OAuth client ID credentials for a desktop application. To run the sample in this
guide, save the credentials as a JSON file named credentials.json to your
local directory.
For guidance, complete the steps for setting up your environment in this
quickstart.
Update the calling user's space notification settings
To update a user's space notification setting, include the following
in your request:
Specify the chat.users.spacesettings authorization scope.
Call the
UpdateSpaceNotificationSetting()
method, passing UpdateSpaceNotificationSetting request to contain the
changes to the notification settings. The request includes:
spaceNotificationSetting with the following properties:
The name property specifies which space notification settings to update
which includes a user ID or alias and a space ID. Updating space
notification settings only supports updating the notification settings of
the calling user, which can be specified by setting one of the following:
The me alias. For example,
users/me/spaces/SPACE/spaceNotificationSetting.
The calling user's Workspace email address. For example,
users/user@example.com/spaces/SPACE/spaceNotificationSetting.
The calling user's user ID. For example,
users/USER/spaces/SPACE/spaceNotificationSetting.
The notificationSetting: sets the notification level, such as ALL, OFF.
The muteSetting: sets the mute on or off, values can be MUTED or UNMUTED.
updateMask: sets the update fields, it can include
notification_setting, mute_setting.
The following example updates the calling user's space notification setting:
import{createClientWithUserCredentials}from'./authentication-utils.js';constUSER_AUTH_OAUTH_SCOPES=['https://www.googleapis.com/auth/chat.users.spacesettings'];// This sample shows how to update the space notification setting for the calling userasyncfunctionmain(){// Create a clientconstchatClient=awaitcreateClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);// Initialize request argument(s), replace the SPACE_NAME with an actual space name.constrequest={spaceNotificationSetting:{name:'users/me/spaces/SPACE_NAME/spaceNotificationSetting',notificationSetting:'ALL',muteSetting:'UNMUTED'},updateMask:{paths:['notification_setting','mute_setting']}};// Make the requestconstresponse=awaitchatClient.updateSpaceNotificationSetting(request);// Handle the responseconsole.log(response);}main().catch(console.error);
To run this sample, replace SPACE_NAME with the ID from
the space's
name.
You can obtain the ID by calling the
ListSpaces()
method or from the space's URL.
The Google Chat API updates the specified space notification settings and returns
an instance of
SpaceNotificationSetting.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["This guide explains how to use the\n[`patch()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.UpdateSpaceNotificationSetting)\nmethod on the `SpaceNotificationSetting` resource of the Google Chat API to update\na user's space notification settings.\n\nThe\n[`SpaceNotificationSetting` resource](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting)\nis a singleton resource that represents details about a specified user's space\nnotification settings.\n\nPrerequisites\n\n\nNode.js\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n\n\u003c!-- --\u003e\n\n- Set up your environment:\n - [Create a Google Cloud project](/workspace/guides/create-project).\n - [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n - [Enable and configure the Google Chat API](/workspace/chat/configure-chat-api) with a name, icon, and description for your Chat app.\n - Install the Node.js [Cloud Client Library](/workspace/chat/libraries?tab=nodejs#cloud-client-libraries).\n - [Create OAuth client ID credentials](/workspace/chat/authenticate-authorize-chat-user#step-2:) for a desktop application. To run the sample in this guide, save the credentials as a JSON file named `credentials.json` to your local directory.\n\n For guidance, complete the steps for setting up your environment in this [quickstart](/workspace/chat/api/guides/quickstart/nodejs\n #set-up-environment).\n- [Choose an authorization scope](/workspace/chat/authenticate-authorize#asynchronous-chat-calls) that supports user authentication.\n\n\n| The code samples in this page use the gRPC API interface with the Google Cloud client libraries. Alternatively, you can use the REST API interface. For more information about the gRPC and REST interfaces, see [Google Chat API overview](/workspace/chat/api/reference).\n\n\u003cbr /\u003e\n\nUpdate the calling user's space notification settings\n\nTo update a user's space notification setting, include the following\nin your request:\n\n- Specify the `chat.users.spacesettings` authorization scope.\n- Call the [`UpdateSpaceNotificationSetting()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.UpdateSpaceNotificationSetting) method, passing `UpdateSpaceNotificationSetting` request to contain the changes to the notification settings. The request includes:\n - `spaceNotificationSetting` with the following properties:\n - The `name` property specifies which space notification settings to update which includes a user ID or alias and a space ID. Updating space notification settings only supports updating the notification settings of the calling user, which can be specified by setting one of the following:\n - The `me` alias. For example, `users/me/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/spaceNotificationSetting`.\n - The calling user's Workspace email address. For example, `users/user@example.com/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/spaceNotificationSetting`.\n - The calling user's user ID. For example, `users/`\u003cvar translate=\"no\"\u003eUSER\u003c/var\u003e`/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/spaceNotificationSetting`.\n - The `notificationSetting`: sets the notification level, such as `ALL`, `OFF`.\n - The `muteSetting`: sets the mute on or off, values can be `MUTED` or `UNMUTED`.\n - `updateMask`: sets the update fields, it can include `notification_setting`, `mute_setting`.\n\nThe following example updates the calling user's space notification setting: \n\nNode.js \nchat/client-libraries/cloud/update-space-notification-setting-user-cred.js \n[View on GitHub](https://github.com/googleworkspace/node-samples/blob/main/chat/client-libraries/cloud/update-space-notification-setting-user-cred.js) \n\n```javascript\nimport {createClientWithUserCredentials} from './authentication-utils.js';\n\nconst USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.users.spacesettings'];\n\n// This sample shows how to update the space notification setting for the calling user\nasync function main() {\n // Create a client\n const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);\n\n // Initialize request argument(s), replace the SPACE_NAME with an actual space name.\n const request = {\n spaceNotificationSetting : {\n \tname : 'users/me/spaces/SPACE_NAME/spaceNotificationSetting',\n \tnotificationSetting : 'ALL',\n \tmuteSetting : 'UNMUTED'\n },\n updateMask : { paths: ['notification_setting','mute_setting']}\n };\n\n // Make the request\n const response = await chatClient.updateSpaceNotificationSetting(request);\n\n // Handle the response\n console.log(response);\n}\n\nmain().catch(console.error);\n```\n\nTo run this sample, replace \u003cvar translate=\"no\"\u003eSPACE_NAME\u003c/var\u003e with the ID from\nthe space's\n[`name`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Space.FIELDS.string.google.chat.v1.Space.name).\nYou can obtain the ID by calling the\n[`ListSpaces()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.ListSpaces)\nmethod or from the space's URL.\n\nThe Google Chat API updates the specified space notification settings and returns\nan instance of\n[`SpaceNotificationSetting`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.SpaceNotificationSetting).\n\nRelated topics\n\n- [Get the calling user's space notification setting](/workspace/chat/get-space-notification-setting)."]]