v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-016280256.4 KB

albums

Update an album

Updates album metadata (name, description, and/or cover). Only the fields included in the request body are changed. To modify the contents of an album, use add_assets_to_album / remove_assets_from_album instead — this tool only changes album metadata.

patch/api/albums/{album_id}

Path parameters

album_idstring required

Album ID (with album_ prefix) of the album to rename or re-describe.

Request body

namestring nullable

New display name for the album. Omit to leave unchanged.

descriptionstring nullable

New free-form description for the album. Pass null to clear the description. Omit to leave unchanged.

album_cover_asset_idstring nullable

Asset 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

idstring required

Unique album identifier with 'album_' prefix

namestring required

Display name of the album

descriptionstring nullable

Optional description text for the album

asset_countinteger required

Total number of assets in this album

album_cover_asset_idstring nullable

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_urlsobject nullable

Asset variants for the album cover: 'thumbnail'

start_datestring date-time nullable

The oldest asset date (local_datetime) in the album, or null if empty

end_datestring date-time nullable

The newest asset date (local_datetime) in the album, or null if empty

created_atstring date-time required

When this album was created

updated_atstring date-time required

When this album was last updated