Update an album
Updates album metadata (name, description, and/or cover). Changes overwrite current metadata; there is no automatic undo. Omitted fields and a null name are unchanged; a null description or cover clears that field. Does not delete the album or its assets. Renaming to another record’s name in the same library returns 409. Names ignore case and surrounding whitespace; retrying the same collision does not resolve it. To modify the contents of an album, use add_assets_to_album / remove_assets_from_album instead — this tool only changes album metadata.
Authorizations
Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.
Path Parameters
Album ID (with album_ prefix) of the album to rename or re-describe.
Body
New display name for the album; must not be blank. Surrounding whitespace is trimmed. Omit or pass null to leave unchanged.
1 - 255New free-form description for the album. Pass null to clear the description. Omit to leave unchanged.
8192Asset ID (with asset_ prefix) to use as the album cover. Must be a live asset already in the album. Pass null to clear the explicit cover. Omit to leave unchanged.
Response
Successful Response
Represents a collection of assets organized by the user.
Unique album identifier with 'album_' prefix
Display name of the album. Names supplied as text on create or update are trimmed and must not be blank.
Total number of assets in this album
When this album was created
When this album was last updated
Optional description text for the album
ID of the asset displayed as the album cover. May be a server-selected default when the album has no explicit cover set, or null when the album has no live assets.
Asset variants for the album cover: 'thumbnail'
The oldest asset date (local_datetime) in the album, or null if empty
The newest asset date (local_datetime) in the album, or null if empty