Update a user's space notification settings

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.

Prerequisites

Node.js

• A Business or Enterprise Google Workspace account with access to Google Chat.

• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Node.js Cloud Client Library.
  • 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.
• Choose an authorization scope that supports user authentication.

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.

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/[e-mail]/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:

Node.js

chat/client-libraries/cloud/update-space-notification-setting-user-cred.js

View on GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.spacesettings',
];

// This sample shows how to update the space notification setting for the
// calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s), replace the SPACE_NAME with an actual space
  // name.
  const request = {
    spaceNotificationSetting: {
      name: 'users/me/spaces/SPACE_NAME/spaceNotificationSetting',
      notificationSetting: 'ALL',
      muteSetting: 'UNMUTED',
    },
    updateMask: {paths: ['notification_setting', 'mute_setting']},
  };

  // Make the request
  const response = await chatClient.updateSpaceNotificationSetting(request);

  // Handle the response
  console.log(response);
}

await main();

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.

Related topics

• Get the calling user's space notification setting.