Skip to main content
PATCH
Update an album

Path Parameters

album_id
string
required

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

Body

application/json
name
string | null

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

Maximum string length: 255
description
string | null

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

Maximum string length: 8192
album_cover_asset_id
string | null

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

Represents a collection of assets organized by the user.

id
string
required

Unique album identifier with 'album_' prefix

name
string
required

Display name of the album

asset_count
integer
required

Total number of assets in this album

created_at
string<date-time>
required

When this album was created

updated_at
string<date-time>
required

When this album was last updated

description
string | null

Optional description text for the album

album_cover_asset_id
string | null

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_urls
Asset Urls · object | null

Asset variants for the album cover: 'thumbnail'

start_date
string<date-time> | null

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

end_date
string<date-time> | null

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