Sample Use Cases & Flow: Social Groups

Create a Group for a Predefined List of People

For example, create a group for each class at a school or each fitness class (yoga, TRX, etc) in a gym.

1. Create a list of site members to add to the relevant group, identified by one of the following: name, email address, phone number, contactId.
2. Create a group by calling the Create Group endpoint.
3. Call the Query Members endpoint to get the site member data.
4. Map the site members to add to the group to their IDs as returned in step 3.
5. Add the site members to the group by calling the Add Group Members endpoint with the site member IDs collected above.

Manage Bulk Emailing to Group Members

For example, send automated emails to group members.

1. Get all members of a group by calling the List Group Members endpoint.
2. From the response, collect the site member IDs.
3. Call the Query Members endpoint, with site member IDs you collected, to get their email addresses.
4. Call the Query Email Subscriptions endpoint to confirm that the members have agreed to receive emails from the site owners.
5. Prepare and send the automated emails.

Provide Analytical Reports

For example, create a report including aggregated group info: total amount of groups created, the most popular groups by member count, idle groups;

1. Get the total amount of groups by calling the List Groups endpoint.
2. From the response, collect the metadata total.
3. Get the most popular groups by calling the Query Groups endpoint and sorting by group size. Sample request body:

1
{
2
    "query": {
3
        "sort": [
4
            {
5
                "fieldName": "membersCount",
6
                "order": "DESC"
7
            }
8
        ],
9
        "paging": {
10
            "offset": 0,
11
            "limit": 100
12
        }
13
    }
14
}

1. Get the idle groups (with the least recent activity) by calling the Query Groups endpoint and sorting by date of most recent activity. Sample request body:

1
{
2
    "query": {
3
        "sort": [
4
            {
5
                "fieldName": "recentActivityDate",
6
                "order": "ASC"
7
            }
8
        ],
9
        "paging": {
10
            "offset": 0,
11
            "limit": 100
12
        }
13
    }
14
}

1. Prepare and display the report.

Send Promotional Emails Based on Members' Interests

Your app can identify group members who are interested in a certain topic by searching for keywords in their answers to the membership questions. Then, your app could send emails to the identified members informing them about upcoming events or special offers.

1. Add membership questions by calling the Create or Replace All Membership Questions endpoint.
2. At any time you want to send emails to selected members, call the List Answers endpoint.
3. Identify the relevant members via a keyword search.
4. Call the Query Email Subscriptions endpoint to confirm that the identified members have agreed to receive emails from the site owners.
5. Prepare and send the automated emails.

Bulk Update Group Rules

The site onwers have decided to manually update the rules for one group. Your app can apply the new rules to other relevant groups.

1. Get the updated group rules by calling the Get Rules endpoint.
2. Save the rules on your server and update them if needed using the Create or Replace Group Rules endpoint.
3. Retrieve a list of all group IDs by calling the List Groups endpoint.
4. Iterate over the list of group IDs and update the rules for each relevant group using the Create or Replace Group Rules endpoint.