Teamdrives: update

Requires authorization

Updates a Team Drive's metadata Try it now.

Request

HTTP request

PATCH https://www.googleapis.com/drive/v3/teamdrives/teamDriveId

Parameters

Parameter name Value Description
Path parameters
teamDriveId string The ID of the Team Drive
Optional query parameters
useDomainAdminAccess boolean Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs. (Default: false)

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/drive

Request body

In the request body, supply the relevant portions of a Teamdrives resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Optional Properties
backgroundImageFile object An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. writable
colorRgb string The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId. writable
name string The name of this Team Drive. writable
restrictions object A set of restrictions that apply to this Team Drive or items inside this Team Drive. writable
themeId string The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. writable

Response

If successful, this method returns a Teamdrives resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Drive REST API
Drive REST API
Need help? Visit our support page.