Teamdrives: update

Requires authorization

Updates a Team Drive's metadata


HTTP request



Parameter name Value Description
Path parameters
teamDriveId string The ID of the Team Drive


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


Request body

In the request body, supply a Teamdrives resource 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
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.insert 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


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

Send feedback about...

Drive REST API v2
Drive REST API v2