Edit Message Caption
telegram.edit_message_caption
ActionChat & messagingconnection required
Calls the Telegram API with the connection's credentials.
Replace the caption on a photo, video or document the bot sent.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Telegram
- Secret shape
- the bot token, or {"token": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
chat_id The chat holding the message: a numeric chat id, or an @channelusername. Required unless inline_message_id is set. | string | No | — | — | — |
message_id Id of the message to edit. | integer | No | — | ≥ 1 | — |
inline_message_id Id of an inline message to edit instead of a chat message; use this or chat_id plus message_id, never both. | string | No | — | — | — |
caption The new caption, 0-1024 characters; leave blank to clear it. | string | No | — | ≤ 1024 characters | — |
parse_mode How to format the text: 'MarkdownV2', 'HTML', or blank for plain text. MarkdownV2 needs every literal _ * [ ] ( ) ~ ` > # + - = | { } . ! escaped with a backslash or Telegram rejects the whole message, so prefer HTML for text interpolated from an expression. | string | No | — | one of "", "MarkdownV2", "HTML" | — |
show_caption_above_media Show the caption above the media; animation, photo and video only. | boolean | No | — | — | — |
reply_markup Keyboard or markup for the message, as the JSON object Telegram documents (inline_keyboard, keyboard, remove_keyboard or force_reply). A JSON string is accepted too and parsed for you. | object | No | — | — | — |
- At least one of inline_message_id, chat_id must be set.
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when Telegram accepted the call. | boolean | true |
message_id Id of the edited message; null for an inline message. | number | — |
message The edited Message object; empty for an inline message. | object | — |
{
"message": {},
"message_id": 0,
"ok": true
}Notes
- chat_id is a numeric chat/user id or an @channelusername. A bot can only message a user who started it, or a group/channel it has been added to.
- The bot token sits in the request URL, so it is redacted out of every error message and dry-run report these nodes produce.
- Telegram answers HTTP 200 even for failures; the node reads the {'ok': …} envelope and raises on ok:false with Telegram's own description.
See Edit Message Caption run in a workflow.
In a technical demo we add the Telegram connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.