---
title: "PATCH /v3/tagKeys/{tagKeysId}"
method: PATCH
path: "/v3/tagKeys/{tagKeysId}"
tags: ["tagKeys"]
---

# PATCH /v3/tagKeys/{tagKeysId}

`PATCH /v3/tagKeys/{tagKeysId}`

## Request

- Base URL: `https://cloudresourcemanager.googleapis.com`
- URL: `https://cloudresourcemanager.googleapis.com/v3/tagKeys/{tagKeysId}`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

Updates the attributes of the TagKey resource.

## Path parameters

- `tagKeysId` string, required

## Query parameters

- `updateMask` string, google-fieldmask
- `validateOnly` boolean

## Request body

- TagKey: A TagKey, used to group a set of TagValues.
  - `allowedValuesRegex` string: Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex).
  - `createTime` string, google-datetime: Output only. Creation time.
  - `description` string: Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.
  - `etag` string: Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
  - `name` string: 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.
  - `namespacedName` string: Output only. Immutable. Namespaced name of the TagKey.
  - `parent` string: Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`.
  - `purpose` 'PURPOSE_UNSPECIFIED' | 'GCE_FIREWALL' | 'DATA_GOVERNANCE': Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.
  - `purposeData` object: Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set.
  - `shortName` string: Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
  - `updateTime` string, google-datetime: Output only. Update time.

## Response `200`

Successful response

- Operation: This resource represents a long-running operation that is the result of a network API call.
  - `done` boolean: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  - `error` Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
    - `code` integer: The status code, which should be an enum value of google.rpc.Code.
    - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
    - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  - `metadata` object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
  - `name` string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  - `response` object: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

---

[API](https://skmtc.dev/google/apis/cloudresourcemanager.md) - [All operations](https://skmtc.dev/google/apis/cloudresourcemanager/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/cloudresourcemanager/revisions/9e107eeb58df?raw)