update_story_album()¶

Client.update_story_album()

Update a story album’s title, contents, or story order.

All parameters except chat_id and album_id are optional. Only the fields you pass will be changed.

Usable by Users Bots

Parameters:

chat_id (int | str) – Unique identifier or username of the peer who owns the album.
album_id (int) – ID of the album to update.
title (str, optional) – New title for the album.
add_story_ids (List of int, optional) – IDs of stories to add to the album.
delete_story_ids (List of int, optional) – IDs of stories to remove from the album.
order (List of int, optional) – New ordered list of story IDs inside the album.

Returns:

StoryAlbum – The updated album.

Example

await app.update_story_album("me", album_id=1, title="Best of 2024")

await app.update_story_album("me", album_id=1, add_story_ids=[105, 106])

await app.update_story_album("me", album_id=1, delete_story_ids=[101])