​

Member Lifecycle

• active: Member has accepted the invitation and is active on the platform.
• invited: Member has been invited but has not yet accepted the invitation.
• inactive: Member has been removed (or offboarded) from the platform.

​

Member Tiers

Members each have exactly one associated “Tier”, which represents their status or level within the platform. Tiers can be used to differentiate between different cohorts of members, each tier may have different offerings within the Onsi platform.

Tiers can be changed at any time via the update member endpoint, and the change will take effect immediately.

​

Single Member Changes

The single member changes APIs allow you to make immediate changes to individual members in your member list. These APIs provide basic CRUD (Create, Read, Update, Delete) operations for managing members.

• Create: Invite a new member to your platform by providing their details.
• Read: Retrieve information about a specific member using their unique identifier.
• Update: Modify attributes of a member, such as updating their Tier, changing their name, or updating other relevant information.
• Delete: Offboard a member from the platform, effectively removing them from your member list.

These changes are executed synchronously and take effect immediately.

​

Bulk Member Changes

The bulk member changes APIs allow you to make batch changes to your member list, enabling you to perform actions on multiple members simultaneously. There are two main approaches to bulk member changes:

1. CSV Upload:

• Upload a CSV file that represents your entire member list.
• The API will calculate the differences (deltas) between the uploaded CSV and your existing member list.
• A “Job” will be created to process the necessary changes, such as adding new members, updating existing members, or offboarding members.
• The request will return a 204 status code along with a unique jobId.
• The job will be executed asynchronously in the background.
• You can poll the API using the jobId to retrieve the latest status or progress of the job.

2. Individual Action List:

• Provide a list of individual actions to be performed on multiple members.
• Each action in the list represents a specific operation, such as adding a member, updating a member, or offboarding a member.
• Unlike the single member changes API, these actions will be executed asynchronously.
• The request will return a unique jobId for tracking the progress and status of the job.
• You can poll the API using the jobId to retrieve the latest status or progress of the job.

Both approaches to bulk member changes allow for efficient management of large member lists and enable you to perform complex operations without the need for multiple individual requests.