Method: projects.locations.agents.entityTypes.patch

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

HTTP request

PATCH https://{endpoint}/v3beta1/{*/locations/*/agents/*/entityTypes/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters



The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Query parameters



The language of the following fields in entityType:

  • EntityType.entities.value
  • EntityType.entities.synonyms
  • EntityType.excluded_phrases.value

If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.


string (FieldMask format)

The mask to control which fields get 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 EntityType.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.