Commands › Groups
group_eject
Remove a member from a group
Usage
curl -X POST "https://api.lifebots.cloud/api/bot.html" \
-H "Content-Type: application/json" \
-d '{
"action": "group_eject",
"apikey": "YOUR_API_KEY",
"botname": "Joe Resident",
"secret": "bot-secret-123",
"groupuuid": "b3f87fed-0470-4a7e-b035-100000000000",
"avatar": "a2e76fcd-9360-4f6d-a924-000000000000",
"dataType": "json"
}' Every request also needs apikey, botname and secret — see Authentication.
Parameters
| Name | Required | Description |
|---|---|---|
groupuuidUUID | yes | Group UUID, or the exact name of a group the bot is in. Also accepted as: group, groupId, groupName |
avatarUUID | yes | Avatar UUID. Also accepted as: target |
ignore_membershipflag | no | 1 to skip the membership check after ejecting (recommended). |
Example response
{
"result": "OK"
} With dataType=json. A failure has result: "FAIL" and the reason in resulttext — see Responses & errors.
Good to know
- The eject is sent first and membership checked afterwards, so a successful eject can come back as FAIL "Ejectee is not in the group". Send ignore_membership=1 and confirm with get_group_members if you need certainty.
- The bot needs the Eject power in the group.