Method: messages.patch

Full name: projects.locations.instances.users.conversations.messages.patch

UpdateMessage is used to update an existing message. Only the most recent message in the given conversation can be updated. Only the inputs field of the message can be updated, which will result in the AI response being updated accordingly.

HTTP request

PATCH https://chronicle.googleapis.com/v1alpha/{message.name}

Path parameters

Parameters
message.name

string

Output only. Full resource name for the message. Format: projects/{project}/locations/{location}/instances/{instance}/users/{user}/conversations/{conversation}/messages/{message}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. If not included, all fields with a non-empty value will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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 the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.messages.update

For more information, see the IAM documentation.