Difference between revisions of "Simple Groups API/eject"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE: eject}} <onlyinclude>Ejects residents from the group.</onlyinclude> {{API Variables Table}} {{API HTTP Group Required Vars|eject}} {{API Variable Group|Inpu...")
 
 
(One intermediate revision by one other user not shown)
Line 21: Line 21:
  
 
{{HTTP API Group - standard footer}}
 
{{HTTP API Group - standard footer}}
 +
 +
{{NavMenu}}
 +
 +
__NOTOC__

Latest revision as of 15:10, 14 October 2019

Ejects residents from the group.

Variables

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

Variable Required Description
Input base:
action yes = eject
apikey yes Your personal developer's API key.
secret yes Security code of the group you are using.
secret_sha1 optional The same as "secret" but hashed using SHA1 (useful if you don't want to keep plain customer's passwords)
Input:
group yes the group name (must be listed with SmartBots!)
slkey yes the UUID of the resident
message optional the optional message to send along with invitation (can't contain international characters)
Output (plain text returned):
OK command completed successfully
anything else Request failed, the fail reason is returned

Important

If you are using a custom role (other than "Everyone") you need an additional abilities for your bot. Read this for details.

<< return back to group commands