Reference
Ban a member
Remove a member and keep them out (supergroups / channels; a basic group can only remove). `untilDate` ends the ban; `deleteHistory` also deletes all their messages. Counted in 'Ban / restrict members'.
View MarkdownThis page is generated from the source code on every release.
Remove a member and keep them out (supergroups / channels; a basic group can only remove). untilDate ends the ban; deleteHistory also deletes all their messages. Counted in 'Ban / restrict members'.
Overview
| Name | Value |
|---|---|
| Code | groups.ban_member |
| Scope needed | groups.admin |
| Risk | Dangerous |
| May need confirmation | Yes |
| Runs as | Queues work for a node |
Needs Idempotency-Key |
Yes |
| Member roles allowed | owner, manager, agent |
| Needs a worker from version | 1.0.37 |
| In the app | Inbox → group info → Manage |
Input fields
| Field | Type | Required | Description |
|---|---|---|---|
conversationId |
uuid |
Yes | |
user |
object |
Yes | |
untilDate |
integer |
No | Unix seconds; null = for ever |
deleteHistory |
true/false |
No |
Example request
curl -X POST https://tlg.builera.app/api/public/v2/ops/groups.ban_member \
-H "Authorization: Bearer $TELEGRAM_AUTO_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: <unique key per operation>" \
-d '{"conversationId":"00000000-0000-0000-0000-000000000000","user":"…"}'Output fields (data)
| Field | Type | Required |
|---|---|---|
ok |
true |
Yes |
jobId |
text |
Yes |
Example answer
{
"data": {
"ok": true,
"jobId": "00000000-0000-4000-8000-000000000000"
}
}Using it over MCP
Not listed on any profile: call tools_describe then tools_run with code: "groups.ban_member". Tool name when listed: groups_ban_member.