Skip to main content
PATCH
/
api
/
albums
/
{album_id}
Update an album
curl --request PATCH \
  --url https://api.example.com/api/albums/{album_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "album_cover_asset_id": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "asset_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "album_cover_asset_id": "<string>",
  "asset_urls": {},
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}

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.

​
description
string | null

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

​
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 — get IDs from list_album_assets. 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

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