Method: spaces.messages.update
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:
When using app authentication, requests can only update messages created by the calling Chat app.
HTTP request
PUT https://chat.googleapis.com/v1/{message.name=spaces/*/messages/*}
The URL uses gRPC Transcoding syntax.
Path 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.
|
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:
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["Updates a Google Chat message using the `PUT` method, preferably with the `patch` approach for partial modifications."],["Requires providing the message's resource name in the URL path for identification."],["Allows specifying fields to update using `updateMask` and supports creating a new message if the original is missing with `allowMissing` set to `true`."],["Authentication can be done using app authentication or user authentication, with app authentication restricting updates to messages created by the calling Chat app."],["Needs authorization with specific OAuth scopes like `chat.bot`, `chat.import`, or `chat.messages`."]]],["This describes updating messages in Google Chat using either `patch` or `put` requests, recommending `patch`. The `PUT` request uses the format `https://chat.googleapis.com/v1/{message.name=spaces/*/messages/*}`. Updating requires specifying the `message.name` path parameter and the `updateMask` query parameter to identify fields to modify. Optional `allowMissing` creates a new message if one is not found. The request and response body are `Message` instances. Authorization requires specific OAuth scopes. App authentication can update messages from the calling app only.\n"]]