Api | /core/api.ts | grammy@v1.11.1

method Api.prototype.unbanChatMember

import { Api } from "https://deno.land/x/grammy@v1.11.1/core/api.ts";

unbanChatMember(

chat_id: number | string,

user_id: number,

other?: Other<R, "unbanChatMember", "chat_id" | "user_id">,

signal?: AbortSignal,

)

Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.

Parameters

chat_id: number | string

Unique identifier for the target group or username of the target supergroup or channel (in the format @username)

user_id: number

Unique identifier of the target user

optional

other: Other<R, "unbanChatMember", "chat_id" | "user_id">

Optional remaining parameters, confer the official reference below

optional

signal: AbortSignal

Optional AbortSignal to cancel the request

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