--- title: "PATCH /v3/folders/{foldersId}" method: PATCH path: "/v3/folders/{foldersId}" tags: ["folders"] --- # PATCH /v3/folders/{foldersId} `PATCH /v3/folders/{foldersId}` ## Request - Base URL: `https://cloudresourcemanager.googleapis.com` - URL: `https://cloudresourcemanager.googleapis.com/v3/folders/{foldersId}` - 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 a folder, changing its `display_name`. Changes to the folder `display_name` will be rejected if they violate either the `display_name` formatting rules or the naming constraints described in the CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field. ## Path parameters - `foldersId` string, required ## Query parameters - `updateMask` string, google-fieldmask ## Request body - Folder: A folder in an organization's resource hierarchy, used to organize that organization's resources. - `configuredCapabilities` string[]: Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: `folders/123/capabilities/app-management`. - `createTime` string, google-datetime: Output only. Timestamp when the folder was created. - `deleteTime` string, google-datetime: Output only. Timestamp when the folder was requested to be deleted. - `displayName` string: The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`. - `etag` string: Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - `managementProject` string: Output only. Management Project associated with this folder (if app-management capability is enabled). Example: `projects/google-mp-123` OUTPUT ONLY. - `name` string: Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234". - `parent` string: Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETE_REQUESTED': Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. - `tags` object: Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. - `updateTime` string, google-datetime: Output only. Timestamp when the folder was last modified. ## 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)