Skip to main content
Module

x/grammy/mod.ts>Api#setChatDescription

The Telegram Bot Framework.
Extremely Popular
Go to Latest
method Api.prototype.setChatDescription
import { Api } from "https://deno.land/x/grammy@v1.11.1/mod.ts";

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters

chat_id: number | string

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

optional
description: string

New chat description, 0-255 characters

optional
signal: AbortSignal

Optional AbortSignal to cancel the request

Official reference: https://core.telegram.org/bots/api#setchatdescription