GOgoogle
teamdrives

PATCH /teamdrives/{teamDriveId}

Changed on

Deprecated: Use drives.update instead.

Request

  • Base URL
    https://www.googleapis.com/drive/v3
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/drive
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/drive

Path parameters

teamDriveIdstring required

The ID of the Team Drive

Query parameters

useDomainAdminAccessboolean

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.

Request body

backgroundImageLinkstring

A short-lived link to this Team Drive's background image.

colorRgbstring

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.

createdTimestring date-time

The time at which the Team Drive was created (RFC 3339 date-time).

idstring

The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".

namestring

The name of this Team Drive.

orgUnitIdstring

The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.

themeIdstring

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.

Response

Successful response

backgroundImageLinkstring

A short-lived link to this Team Drive's background image.

colorRgbstring

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.

createdTimestring date-time

The time at which the Team Drive was created (RFC 3339 date-time).

idstring

The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.

kindstring

Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".

namestring

The name of this Team Drive.

orgUnitIdstring

The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.

themeIdstring

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.

Changes

  • 2dd100dc9305Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status