You are viewing the legacy documentation for the Google Photos Library API.
Method: albums.patch
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-09 UTC."],[[["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."]]],[]]
