View source for Simple Groups API/invite

{{DISPLAYTITLE: invite}}
<onlyinclude>Sends the group invitation to specific resident.</onlyinclude>

{{API Variables Table}}

{{API HTTP Group Required Vars|invite}}

{{API Variable Group|Input}}
{{API Variable|group|yes}} the group '''name''' (must be listed with SmartBots!)
{{API Variable|slkey|yes}} the UUID of the resident
{{API Variable|role|no}} the group role '''name''' (default 'Everyone')
{{API Variable|message|no}} the optional message to send along with invitation (can't contain international characters)
{{API Variable|force|no}} if equals to 1 - invite existing group members also (otherwise silently ignore them)
{{API Variable|cooldown|no}} set to X seconds = do not send other invitation to this resident during next X seconds. Maximum value is 86400 seconds (24 hours) 
{{API Variable|location|no}} put a location address here, it will be visible in statistics instead of automatic one.

Format: ''REGION NAME/X/Y/Z''
{{API Variable|misc|no}} set the custom "Misc" value in group invitation statistics.

Format: ''any text, 60 characters max''

{{API Variable Group|Output (plain text returned)}}
{{API HTTP Group Standard Output}}

{{API Variables Table End}}

== Example ==

The following example sends a direct group invitation to a resident touching the object (the group name is "My Group Name"). The greeting IM is being delivered along with the invitation.

<syntaxhighlight lang="lsl">
touch_start(integer num) {
  string params = llDumpList2String([
    "action="  + "invite",
    "apikey="  + llEscapeURL(yourApiKey),
    "secret="  + llEscapeURL(groupSecretCode),
    "group="   + llEscapeURL("My Group Name"),
    "slkey="   + (string)llDetectedKey(0),
    "force="   + "1", // Invite group members too
    "message=" + llEscapeURL("Welcome!")], // Send a greeting IM
    "&");

  llHTTPRequest(
    "https://api.mysmartbots.com/api/simple.html",
    [HTTP_METHOD,"POST"],
    params
   );
}
</syntaxhighlight>



{{HTTP API Group - standard footer}}

{{NavMenu}}

__NOTOC__