Concepts

In Falkor Groups, users can be categorised into segments. This allows for private content distribution and filtering in Analytics. Groups also send invites to users that are added to a group for the first time.

To learn more about what groups are and how they are used, you can read the documentation here: https://docs.falkor.io/groups/managing-groups

Invites

Invites automatically occur when a user is added to any group for the first time. Once they have been notified, they will not receive additional invites when added to additional groups. This means users receive 1 invite regardless of how many subsequent groups they are added to.

When using the Group API and adding users, invites are sent with a 1-5 minute delay. This ensures the API response is optimised without waiting for invites to send.

You can disable automatic invites by setting the "invite" parameter to "0" for the groups/insert & groups/manage endpoints.

User Object

When using the manage or insert endpoints, the add or user parameter expects a user object. The user object contains required and optional parameters.

Key	Type
REQUIRED
firstname	String
lastname	String
email	String (Valid Email)
OPTIONAL
telephone	String (e.g [phone])

Group API Endpoints

Manage

The manage endpoint allows for managing multiple users in a single group. This is useful for bulk user add / remove actions to a group.

Manage

Status

The status endpoint allows for retrieving multiple user invite status and allocated groups. This is useful if you wish to track the invite status of users.

Status

Insert

The insert endpoint allows for adding a single user to multiple groups. This is similar to the add parameter for the manage endpoint but allows for multiple group assignments.

Insert

Remove

The remove endpoint allows for removing a single user from multiple groups. This is similar to the remove parameter for the manage endpoint but allows for multiple group removals.

Remove