Page Summary

outlined_flag

• This guide explains how to delete a Google Chat space and its contents (messages, attachments) using thedelete() method.

• Google Workspace administrators can delete any named space within their organization.

• Prerequisites include a Google Workspace account, a Google Cloud project, and necessary API configurations.

• Two deletion methods are outlined: one using user authentication for personal spaces and another using app authentication (developer preview) for app-created spaces.

• Google Workspace administrators have the additional capability to delete any named space using admin privileges.

This guide explains how use thedelete()method on theSpace resource of the Google Chat API to delete a named space whenit's no longer needed. Deleting a space also deletes everything that itcontains, including messages and attachments.

If you're a Google Workspace administrator, you can call thedelete()method to delete any named space in your Google Workspace organization.

TheSpace resourcerepresents 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 anda Chat app.
• Group chats are conversations between three or more users andChat apps.
• Named spaces are persistent places where people send messages, share files,and collaborate.

Prerequisites

The code samples in this page use the gRPC API interface with the Google Cloud clientlibraries. Alternatively, you can use the REST API interface. For more information about the gRPCand REST interfaces, seeGoogle Chat API overview.

Delete a named space as a user

To delete an existing space in Google Chat withuser authentication, passthe following in your request:

• Specify thechat.delete authorization scope.
• Call theDeleteSpace()method.
• Pass thename of the space to delete.

Here's how to delete a space:

import{createClientWithUserCredentials}from'./authentication-utils.js';constUSER_AUTH_OAUTH_SCOPES=['https://www.googleapis.com/auth/chat.delete'];// This sample shows how to delete a space with user credentialasyncfunctionmain(){// Create a clientconstchatClient=awaitcreateClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES,);// Initialize request argument(s)constrequest={// Replace SPACE_NAME herename:'spaces/SPACE_NAME',};// Make the requestconstresponse=awaitchatClient.deleteSpace(request);// Handle the responseconsole.log(response);}awaitmain();

To run this sample, replaceSPACE_NAME with the ID fromthe space'snamefield. You can obtain the ID by calling theListSpaces()method or from the space's URL.

Delete a named space as a Chat app

App authentication requires one-timeadministrator approval.

With app authentication, you can only delete spaces created byChat apps.

To delete an existing space in Google Chat withapp authentication, passthe following in your request:

• Specify thechat.app.delete authorization scope.
• Call thedelete methodon theSpace resource.
• Pass thename of the space to delete.

Write a script that calls Chat API

Here's how to delete a space:

If successful, the response body is empty, which indicates that the space isdeleted.

Delete a named space as a Google Workspace administrator

If you're a Google Workspace administrator, you can call theDeleteSpace() method to delete any named space in yourGoogle Workspace organization.

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

• Call the method using user authentication, and specify anauthorization scopethat supports calling the method usingadministrator privileges.
• In your request, specify the query parameteruseAdminAccess totrue.

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

Related topics

• Create a space
• Get details about a space.
• List spaces.
• Update a space.
• Delete a space.
• Set up a space.
• Find a direct message space.