This guide explains how to use the patch() method on the Space resource of the Google Chat API to update a space. Update a space to change attributes about a space, like its user-visible display name, description, and guidelines.

If you're a Google Workspace administrator, you can call the patch() method to update any existing space in your Google Workspace organization.

The Space resource represents a place where people and Chat apps can send messages, share files, and collaborate. There are several types of spaces:

• Direct messages (DMs) are conversations between two users or a user and a Chat app.
• Group chats are conversations between three or more users and Chat apps.
• Named spaces are persistent places where people send messages, share files, and collaborate.

Prerequisites

Update a space as a user

To update an existing space in Google Chat with user authentication, pass the following in your request:

• Specify the chat.spaces authorization scope.
• Call the UpdateSpace() method. In your request, you specify the space name field, the updateMask field with one or more fields to update, and a body with the updated space information.

You can update things like the display name, space type, history state, and more. To see all the fields you can update, see the reference documentation.

Here's how to update the displayName field of an existing space:

To run this sample, replace SPACE_NAME with the ID from the space's name field. You can obtain the ID by calling the ListSpaces() method or from the space's URL.

The Google Chat API returns an instance of the Space reflecting the updates.

Update a space as a Google Workspace administrator

If you're a Google Workspace administrator, you can call the UpdateSpace() method to update any space in your Google Workspace organization.

To call this method as a Google Workspace administrator, do the following:

• Call the method using user authentication, and specify an authorization scope that supports calling the method using administrator privileges.
• In your request, specify the query parameter useAdminAccess to true.

For more information and examples, see Manage Google Chat spaces as a Google Workspace administrator.

Update a space as a Chat app

App authentication requires one-time administrator approval.

To update an existing space in Google Chat with app authentication, pass the following in your request:

• Specify the chat.app.spaces authorization scope. With app authentication, you can only update spaces created by Chat apps.
• Call the patch method on the Space resource. In your request, you specify the space name field, the updateMask field with one or more fields to update, and a body with the updated space information.

You can update things like the display name, space type, history state, permission settings, and more. To see all the fields you can update, see the reference documentation.

Write a script that calls Chat API

Here's how to update the spaceDetails field of an existing space:

Python

1. In your working directory, create a file named chat_space_update_app.py.

2. Include the following code in chat_space_update_app.py:

   from google.oauth2 import service_account
   from apiclient.discovery import build
   
   # Define your app's authorization scopes.
   # When modifying these scopes, delete the file token.json, if it exists.
   SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"]
   
   def main():
       '''
       Authenticates with Chat API using app authentication,
       then updates the specified space description and guidelines.
       '''
   
       # Specify service account details.
       creds = (
           service_account.Credentials.from_service_account_file('credentials.json')
           .with_scopes(SCOPES)
       )
   
       # Build a service endpoint for Chat API.
       chat = build('chat', 'v1', credentials=creds)
   
       # Use the service endpoint to call Chat API.
       result = chat.spaces().patch(
   
         # The space to update, and the updated space details.
         #
         # Replace {space} with a space name.
         # Obtain the space name from the spaces resource of Chat API,
         # or from a space's URL.
         name='spaces/SPACE',
         updateMask='spaceDetails',
         body={
   
           'spaceDetails': {
             'description': 'This description was updated with Chat API!',
             'guidelines': 'These guidelines were updated with Chat API!'
           }
   
         }
   
       ).execute()
   
       # Prints details about the updated space.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. In the code, replace the following:

   • SPACE with a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.

4. In your working directory, build and run the sample:

   python3 chat_space_update_app.py

The Google Chat API returns an instance of the Space resource reflecting the updates.

Limitations and considerations

• With app authentication, Chat apps:
  • Can only update predefinedPermissionSettings or permissionSettings in spaces they created.
  • Can't update accessSettings.audience.

• Get details about a space.
• List spaces.
• Delete a space.
• Set up a space.
• Find a direct message space.
• Make a space discoverable to specific users.