Methods

editStory

Edit a story. USER-ONLY

Parameters

chatId: ID

The identifier of the chat including the story.

storyId: number

The identifier of the story to edit.

The story’s new content.

interactiveAreas?: StoryInteractiveArea[]

The story’s new interactive areas.

privacy?: StoryPrivacy

The story’s new privacy settings.

caption?: string

The caption to attach.

captionEntities?: MessageEntity[]

The caption’s entities.

parseMode?: ParseMode

The parse mode to use for the caption. If omitted, the default parse mode will be used.

fileName?: string

The file name to assign if applicable.

fileSize?: number

The file’s size.

mimeType?: string

The MIME type to assign if applicable.

chunkSize?: number

Size of each upload chunk in bytes.

signal?: AbortSignal

Upload abort signal.

progressId?: string

A progress ID retrieved from the method getProgressId. If specified, updates on the upload progress will be sent.

Result

The edited story.

Syntax

// Required parameters only.
await client.editStory(chatId, storyId);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.editStory(chatId, storyId, {
    content,
    interactiveAreas,
    privacy,
    caption,
    captionEntities,
    parseMode,
    fileName,
    fileSize,
    mimeType,
    chunkSize,
    signal,
    progressId,
});