SB_INVITE_SEND
Invites resident to the group.
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description
| |
|---|---|---|---|
| str | yes | flags
The following flags can be used:
The flags have to be separated by commas (see the "Examples" section below). | |
| id | yes | avatar UUID | |
Comments
This command invites resident to the group. By default, existing group members are not invited. The invitation is being sent to the "Everyone" role.
The default behavior can be changed by using flags.
Important: existing members check
Bot updates the list of existing members every hour. Thus,
- if avatar leaves the group, bot will not invite him to the group during the next 60 minutes.
- if avatar just joined the group, immediate second join command will send another group invitation (bot still does not know about new group member).
Take this into account while testing your group inviter.
Roles
1. Use the role name, not the role title! The name is case-sensitive.
Make sure that you use the role name. Using the role title (or the role tag name) won't work. Also remember that role name is cAsE SeNsItIvE!
If role-name is misspelled, then invite will work though but will invite avatars to default Everyone role.
2. Give the necessary permissions to the bot!
Inviting to the specific role requires additional group setup:
- "Assign members to Assigner's Roles" ability given to the bot
- Bot have to be a member of that role.
If bot has lack abilities, the flashing pop-up appears in viewer of the invited person, reporting that "Inviter is lack of permission...".
Read Inviting residents to custom role page for more details.
Examples
See Goup Inviter Script for group inviter example.
