Method: spaces.messages.delete

  • This method enables you to delete messages and optionally their replies using an HTTP DELETE request.

  • It supports both app and user authentication, with app authentication limiting deletion to messages created by the app.

  • You can specify whether to force delete threaded replies with the force query parameter when using user authentication.

  • The request requires specifying the message's resource name in the URL path and an empty request body.

  • Authorization is required using one of the specified OAuth scopes.

Deletes a message. For an example, see Delete a message.

Supports the following types of authentication:

  • App authentication with the authorization scope:

    • https://www.googleapis.com/auth/chat.bot

  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (import mode spaces only)

When using app authentication, requests can only delete messages created by the calling Chat app.

HTTP request

DELETE https://chat.googleapis.com/v1/{name=spaces/*/messages/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the message.

Format: spaces/{space}/messages/{message}

If you've set a custom ID for your message, you can use the value from the clientAssignedMessageId field for {message}. For details, see Name a message.

Query parameters

Parameters
force

boolean

Optional. When true, deleting a message also deletes its threaded replies. When false, if a message has threaded replies, deletion fails.

Only applies when authenticating as a user. Has no effect when authenticating as a Chat app.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

For more information, see the Authorization guide.