Method: albums.patch
Stay organized with collections
Save and categorize content based on your preferences.
Update the app created 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.
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 2025-04-01 UTC.
[null,null,["Last updated 2025-04-01 UTC."],[[["\u003cp\u003eThis endpoint allows you to update an album's \u003ccode\u003etitle\u003c/code\u003e and \u003ccode\u003ecoverPhotoMediaItemId\u003c/code\u003e using a \u003ccode\u003ePATCH\u003c/code\u003e request to \u003ccode\u003ehttps://photoslibrary.googleapis.com/v1/albums/{album.id}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe album must have been created by the developer via the API and be owned by the user.\u003c/p\u003e\n"],["\u003cp\u003eYou need to specify the fields to be updated using the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter and provide the updated album data in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/photoslibrary.edit.appcreateddata\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["To update an album, use a `PATCH` request to the specified URL, including the `album.id` as a path parameter. The `updateMask` query parameter is required to specify fields to update, which can be `title` or `coverPhotoMediaItemId`. The request body contains the album data. The response body returns the updated album. Authorization requires the `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata` scope. The provided album must have been created by the developer via the API and owned by the user.\n"],null,["# Method: albums.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate the app created 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.\n\n### HTTP request\n\n`PATCH https://photoslibrary.googleapis.com/v1/albums/{album.id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------|\n| `album.id` | `string` Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [Album](/photos/library/reference/rest/v1/albums#Album).\n\n### Response body\n\nIf successful, the response body contains an instance of [Album](/photos/library/reference/rest/v1/albums#Album).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/photoslibrary.edit.appcreateddata`"]]
