group_eject

Ejects a resident from a group.

This API command applies only for Standard bots.

// See "LSL Helper Functions" page for this function
smartbotsAPI("group_eject", [
  "avatar", "417732f0-a100-4e2d-a9bf-e381cfd12c3a",
  "groupuuid", "0b65a122-8f77-64fe-5b2a-225d4c490d9c"
]);

Variables

The following table shows input values (you send them with the API call) and returned output values.

Input basic parameters

Variable	Required	Description
action	yes	= group_eject
apikey	yes	Your personal developer's API key
botname	yes	Your bot's SL login
secret	yes	Bot access code of your bot
dataType	optional	Set to "json" to get JSON reply instead of URL-encoded string
custom	optional	The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response

Input

Variable	Required	Description
avatar	yes	The UUID of the resident to eject
groupuuid	yes	The UUID of the group
ignore_membership	optional	Set to `1` to return success even if the resident is not in the group (see Return value below)

Output

(To be received in *http_response* LSL event, see docs for details)

Variable	Description
result	OK - command completed successfully FAIL - command failed
resulttext	Detailed reason for the failure
custom	The value from input "custom" parameter. See above

Return value

By default, the command returns success (OK) when the resident has been successfully ejected.
If the resident is not a member of the group, an error message is returned:

Ejectee is not in the group

If you don’t need to verify membership, set ignore_membership to 1 — this forces the command to return OK even when the resident is not in the group.

Custom roles

If your bot attempts to eject a member with a custom role (other than “Everyone”), additional abilities are required.
For details, see Inviting and ejecting from custom roles.