Method: projects.locations.tagTemplates.fields.patch

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

HTTP request


Path parameters



Required. The name of the tag template field. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{tagTemplateFieldId} It takes the form projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}.

Query parameters


string (FieldMask format)

Optional. The field mask specifies the parts of the template to be updated. Allowed fields:

  • displayName
  • type.enum_type
  • isRequired

If updateMask is not set or empty, all of the allowed fields above will be updated.

When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

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

Request body

The request body contains an instance of TagTemplateField.

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.