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/{projectId}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{tagTemplateFieldId} It takes the form projects/{project}/locations/{location}/tagTemplates/{tagtemplate}/fields/{field}.

Query parameters


string (FieldMask format)

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • displayName
  • type.enum_type
  • isRequired

If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

Additionally, updating a template field from optional to required is not allowed.

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