Sign in
Albums

Update an album

Changed on

Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.

patch/albums/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/albums/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Path parameters

idstring uuid required

Request body

albumNamestring

Album name

albumThumbnailAssetIdstring uuid

Album thumbnail asset ID

descriptionstring

Album description

isActivityEnabledboolean

Enable activity feed

order'asc' | 'desc'

Asset sort order

Response

albumNamestring required

Album name

albumThumbnailAssetIdstring uuid nullable required

Thumbnail asset ID

assetCountinteger required

Number of assets

createdAtstring date-time required

Creation date

descriptionstring required

Album description

endDatestring date-time

End date (latest asset)

hasSharedLinkboolean required

Has shared link

idstring uuid required

Album ID

isActivityEnabledboolean required

Activity feed enabled

lastModifiedAssetTimestampstring date-time

Last modified asset timestamp

order'asc' | 'desc'

Asset sort order

sharedboolean required

Is shared album

startDatestring date-time

Start date (earliest asset)

updatedAtstring date-time required

Last update date

Changes

  • 2cd7bd44a940Revision changes
    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the // response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • 263499da0778Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new owner enum value to the // response property for the response status