Method: projects.locations.companionAgents.patch

Updates a companion agent.

HTTP request

PATCH https://{endpoint}/v2/{companionAgent.name=projects/*/locations/*/companionAgents/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
companionAgent.name

string

Identifier. The unique identifier of the companion agent. Format: projects/{project}/locations/{location}/companionAgents/{companionAgent}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Update mask for Companion Agent.

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

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.