Got 5 minutes? Help us improve the Google Chat developer documentation by taking a quick survey.

Method: spaces.messages.patch

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.

Requires authentication. Fully supports service account authentication and user authentication. User authentication. Requests authenticated with service accounts 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
message.name

string

Resource name in the form spaces/*/messages/*.

Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The field paths to update. Separate multiple values with commas.

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.