Invite users to a group

Users may be invited to the site and prestaged in a group.

Upon account creation the user will be added to this group.

This feature is useful when you wish to invite a group of private beta testers, employees, etc.

This feature is only available to forum staff and group owners. Staff can create an invite that adds users to any custom group on the site from the Invites section of their profile page. Group owners can only invite new users to a group from the group page.

Using the UI by clicking the “Invite” button from your staff account’s profile page, select the groups you want to add the invited users to from the “Add to groups” drop down:

To invite users to a group from the group’s page, click the “Invite” button from that page:

Note that if group owners perform this action from a group’s page, they will only be allowed to invite users to groups that they are the owners of.

Using the API:

require 'discourse_api'
client = DiscourseApi::Client.new("somesite",port)
client.api_key = "your key"
client.api_username = "an_admin"

client.invite_user_to_topic(topic_id: 1, email: "bob@bob.com", group_ids: "1,2,3")
client.invite_user_to_topic(topic_id: 1, email: "bob@bob.com", group_names: "bugs,cars,testers")

Limitations

It is not possible to invite users to predefined groups such as, trust level groups, admin, mod or staff groups. As a work around, you can configure a custom group to automatically set a users trust level in the Effects section of the group’s configuration page. Doing this will allow you to set the trust level of invited users to a trust level other than what is set by your site’s default invitee trust level setting.

10 Likes