edit_story_caption()¶

Client.edit_story_caption()¶

Edit the caption of story.

Usable by Users Bots

Parameters:¶

• chat_id (``int`` | ``str``) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”.

• story_id (``int``) – Story identifier in the chat specified in chat_id.

• caption (``str``) – New caption of the story, 0-1024 characters.

• parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

• caption_entities (List of :obj:`~pyrogram.types.MessageEntity`) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

Returns:¶

:obj:`~pyrogram.types.Story` (On success, the edited story is returned.)

Example

await app.edit_story(chat_id, story_id, "new media caption")