Method: projects.locations.agents.patch

Updates the specified agent.

Note: You should always train flows prior to sending them queries. See the training documentation.

HTTP request

PATCH https://{endpoint}/v3/{*/locations/*/agents/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters



The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Query parameters


string (FieldMask format)

The mask to control which fields get updated. If the mask is not present, all fields will be updated.

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 Agent.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.