update_story_album()

async Client.update_story_album()

Update a story album (highlight).

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • album_id (int) – ID of the album to update.

  • title (str, optional) – New title for the album.

  • delete_stories (List of int, optional) – List of story IDs to remove from the album.

  • add_stories (List of int, optional) – List of story IDs to add to the album.

  • order (List of int, optional) – New order of story IDs in the album.

Returns:

StoryAlbum – On success, the updated story album is returned.

Example

album = await app.update_story_album(
    chat_id=chat_id,
    album_id=album_id,
    title="New Title",
    add_stories=[4, 5]
)
print(album)