editMessageCaption

Edit a message’s caption.

Parameters

chatId: ID

The identifier of the chat that contains the message.

messageId: number

The message’s identifier.

businessConnectionId?: string

The identifier of a business connection ID to perform the action on. Bot-only.

caption?: string

The message’s new caption. If omitted, the caption will be removed.

parseMode?: ParseMode

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

entities?: MessageEntity[]

The caption’s entities.

replyMarkup?: ReplyMarkup

The reply markup of the message. Bot-only.

Result

Message

The edited message.

Syntax

// Required parameters only.
await client.editMessageCaption(chatId, messageId);

// Required parameters + optional parameters.
// Any of the optional parameters can be omitted.
await client.editMessageCaption(chatId, messageId, {
    businessConnectionId,
    caption,
    parseMode,
    entities,
    replyMarkup,
});