Method: tagKeys.patch

Updates the attributes of the TagKey resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

Query parameters


string (FieldMask format)

Fields to be updated. The mask may only contain description or etag. If omitted entirely, both description and etag are assumed to be significant.

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



Set as true to perform validations necessary for updating the resource, but not actually perform the action.

Request body

The request body contains an instance of TagKey.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.