Set Chat Description
telegram.set_chat_description
ActionChat & messagingconnection required
Calls the Telegram API with the connection's credentials.
Change the description of a group, supergroup or channel.
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
2 fields, 1 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 to describe: a numeric chat/user id, or an @channelusername. | string | Yes | — | — | — |
description The new description, 0-255 characters; leave blank to clear it. | string | No | — | ≤ 255 characters | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when Telegram accepted the call. | boolean | true |
chat_id The chat that was described. | string | — |
description The description that was set. | string | — |
{
"chat_id": "",
"description": "",
"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.
- The bot must be an administrator with the right to change chat info.
See Set Chat Description 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.