Method: projects.agent.entityTypes.batchUpdate

Stay organized with collections Save and categorize content based on your preferences.

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

HTTP request

POST https://{endpoint}/v2/{parent=projects/*/agent}/entityTypes:batchUpdate

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

The URLs use gRPC Transcoding syntax.

Path parameters



Required. The name of the agent to update or create entity types in. Format: projects/<Project ID>/agent.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.entityTypes.batchUpdate

Request body

The request body contains data with the following structure:

JSON representation
  "languageCode": string,
  "updateMask": string,

  // Union field entity_type_batch can be only one of the following:
  "entityTypeBatchUri": string,
  "entityTypeBatchInline": {
    object (EntityTypeBatch)
  // End of list of possible types for union field entity_type_batch.


Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.


string (FieldMask format)

Optional. The mask to control which fields get updated.

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

Union field entity_type_batch. The source of the entity type batch.

For each entity type in the batch:

  • If name is specified, we update an existing entity type.
  • If name is not specified, we create a new entity type. entity_type_batch can be only one of the following:


The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".


object (EntityTypeBatch)

The collection of entity types to update or create.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.