Invite Member
This invites a new member to your platform, when they are created they will have the status of invited, if their email already has an associated Onsi account their status will go straight to active.
Relevant Error Codes
If there are any issues with the member add, the API will return a 400 status code with the following error codes:
- MemberAlreadyInvited a member with this email is currently active or invited.
- InvalidAddMemberPayload for any other add member payload issues.
Authorizations
Headers
Unique key to ensure idempotency of the request
Body
A unique email address for the member
Tier name for the member
An optional phone number for the member
Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)
Response
A member on the platform.
Onsi's ID of the member
The status of the member.
active, invited, inactive Tier name for the member
Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)