API Reference › Registered Groups
Eject
POST
/groups/{group_id}/ejectRemove a member from the group.
Scopewrite:groups
Groups the user registered on LifeBots — on their own bot or a SharedBot — acted on through the bot that runs each group. Commands fail with GROUP_NOT_ACTIVE unless the group's status is running. For any group the user's own bot is in, registered or not, use Bots — Group Moderation.
Usage
curl -X POST "https://api.lifebots.cloud/api/v1/groups/$GROUP_ID/eject" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"avatar": "7d1d5c58-2a8f-4c3e-9b11-0a6e5f2c9e41"
}'Path parameters
| Name | Type | Description |
|---|---|---|
group_id | UUID | Group UUID. |
Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
avatar | UUID | yes | Avatar UUID. |
Example response
{
"success": true,
"data": {
"result": "OK",
"action": "group_eject"
},
"meta": {
"timestamp": "2026-10-02T12:00:00.000Z",
"version": "1.0"
}
}The bot checks membership after ejecting, so a successful eject can come back as result "FAIL" with "Ejectee is not in the group". Confirm with the member list if you need certainty.
Always check success; for commands the bot carries out, also check data.result. See Responses & errors.