restrictChatMember

Description

Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Arguments

Name Type Description
chat_id Union[int, str] Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
user_id int Unique identifier of the target user
permissions ChatPermissions New user permissions
until_date Optional[Union[datetime.datetime, datetime.timedelta, int]] Optional. Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever

Response

Type: bool

Description: Returns True on success.

Usage

As bot method

result: bool = await bot.restrict_chat_member(...)

Method as object

Imports:

  • from aiogram.methods import RestrictChatMember
  • from aiogram.api.methods import RestrictChatMember
  • from aiogram.api.methods.restrict_chat_member import RestrictChatMember

In handlers with current bot

result: bool = await RestrictChatMember(...)

With specific bot

result: bool = await bot(RestrictChatMember(...))

As reply into Webhook in handler

return RestrictChatMember(...)