​
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.

​
Categories of Member Management

​
1. Full Member List CSV:

The full member list CSV allows you to inform of us your complete member list, this allows us to calculate the differences and action that.

For instance, if you have 100 members in your existing member list, and you upload a new CSV with 50 members, we will update any members who have changed, and offboard the 50 members who are no longer in the list.

This is identical to the CSV uploaded through the Onsi Platform for batch member management

​
2. Single Member Actions

This is our most reactive method of managing members, you can create, read, update and delete members in real-time - we will action changes immediately and return the result straight away.

  • 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.
  • Replace: Replace attributes of a member. Inactive members will be re-invited on to the platform.
  • Delete: Offboard a member from the platform, effectively removing them from your member list.

​
3. Batch Member Actions

This is the batch version of the single member actions, you can perform multiple actions on multiple members at once, this is useful for executing large changes to your member list.

For example, this is the ideal method for updating the Tier of 100 members at once, or offboarding 50 members in one go.

Our recommended approach for updating your programme is to use the Create Batch Job API. This API allows you to send an array of actions to be performed on your members. While it requires you to calculate which actions to take on your end, it offers greater control and ensures that updates align precisely with your system’s logic. Additionally, this API allows you to batch multiple actions into a single request, making it efficient for synchronising your programme at specific intervals.

If you prefer to target individual members, you can use the single-member APIs. These APIs allow you to update, invite, or remove specific members by their Member ID, giving you full control over changes on a case-by-case basis.

Alternatively, you can use the Upload Full Member List CSV API. This API takes a CSV of your current member list and performs all the necessary calculations automatically, determining whether a member needs to be invited, re-invited, updated, or removed. However, this approach is more destructive because it replaces the current state of your programme and may cause unintended side effects if the CSV does not accurately reflect your desired member state.

​
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 or the replace member endpoint, and the tier change will take effect immediately.

​
Member Action Jobs

When you perform a bulk action, you will receive back a jobId, this ID can be used to query the status of the job to see if it has completed, please see the get job endpoint for more information.