Method: albums.patch

  • This API updates an album with a specified ID, modifying only the title and cover photo, if provided in the request.

  • The album being updated must have been created by the developer via the API and be owned by the user.

  • A PATCH request is used, targeting the album's ID in the URL.

  • An updateMask query parameter is required to specify which album fields (title, coverPhotoMediaItemId) are being updated.

  • The request body should contain an Album object with the updated fields, and the response, if successful, also contains an Album object.

Update the album with the specified id. Only the id, title and coverPhotoMediaItemId fields of the album are read. The album must have been created by the developer via the API and must be owned by the user.

HTTP request

PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
album.id

string

Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Indicate what fields in the provided album to update. The only valid values are title and coverPhotoMediaItemId.

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

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata