Method: folders.patch

Updates a folder, changing its displayName. Changes to the folder displayName will be rejected if they violate either the displayName formatting rules or the naming constraints described in the folders.create documentation.

The folder's displayName 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}][\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.

HTTP request

PATCH https://cloudresourcemanager.googleapis.com/v3/{folder.name=folders/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
folder.name

string

Identifier. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Fields to be updated. Only the displayName can be updated.

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

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudplatformfolders

For more information, see the Authentication Overview.