POST
/
v1
/
members

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 accout their status will go straight to active.

Authorizations

X-API-KEY
string
headerrequired

Headers

x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json
email
string
required

A unique email address for the member

firstName
string
required
lastName
string
required
phone
string

An optional phone number for the member

workerId
string

Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)

tier
string
required

Tier name for the member

accountDetails
object
enablePayroll
boolean

Response

201 - application/json
email
string
required
memberId
string
required

Onsi's ID of the member

firstName
string
required
lastName
string
required
phone
string | null
required
tier
string
required

Tier name for the member

workerId
string | null
required

Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)

status
enum<string>
required

The status of the member.

Available options:
active,
invited,
inactive
accountDetails
object
required
enablePayroll
boolean
required
Get MemberUpdate Member