Member Management API
Everything you need to know about managing your members via the Onsi Member API. Below you’ll find documentation on how to create and update your members without the need for manual administration via the Onsi Platform.
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.
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.
- 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.
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.
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.