Method: spaces.messages.patch

AI-generated Key Takeaways

Updates a Google Chat message using the PATCH method, preferably over the update method which uses PUT .
Supports both app and user authentication, with app authentication limited to updating messages created by the calling Chat app.
Requires specifying the message to update using its resource name in the URL path and the fields to update using the updateMask query parameter.
Allows creation of a new message if the original is not found when allowMissing query parameter is set to true and a client-assigned message ID is provided.
Requires authorization with one of the specified OAuth scopes ( chat.bot , chat.import , or chat.messages ).

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
Try it!

Updates a message. There's a difference between the patch and update methods. The patch method uses a patch request while the update method uses a put request. We recommend using the patch method. For an example, see Update 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 update messages created by the calling Chat app.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`message.name`	`string` Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` . If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name` . For details, see Name a message .

message.name

string

Identifier. Resource name of the message.

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

Where {space} is the ID of the space where the message is posted and {message} is a system-assigned ID for the message. For example, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB .

If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing {message} with the value from the clientAssignedMessageId field. For example, spaces/AAAAAAAAAAA/messages/client-custom-name . For details, see Name a message .

Query parameters

Parameters

updateMask

string ( FieldMask format)

Required. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

text
attachment
cards (Requires app authentication .)
cardsV2 (Requires app authentication .)
accessoryWidgets (Requires app authentication .)
quotedMessageMetadata (Only allows removal of the quoted message.)

allowMissing

boolean

Optional. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

Request body

The request body contains an instance of Message .

Response body

If successful, the response body contains an instance of Message .

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 .

Method: spaces.messages.patch Stay organized with collections Save and categorize content based on your preferences.