Single Member Actions
Update Member
PATCH
/
v1
/
members
/
{id}
Updates an existing member, identified by their member_id
.
Authorizations
X-API-KEY
string
headerrequiredHeaders
x-idempotency-key
string
Unique key to ensure idempotency of the request
Path Parameters
id
string
requiredThe unique identifier for a Member, prefixed with mem_
Body
application/json
email
string
This can only be changed if member status is invited
firstName
string
First name of the member
lastName
string
Last name of the member
phone
string
Phone number
workerId
string | null
Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)
tier
string
Tier name
accountDetails
object
enablePayroll
boolean
Response
200 - application/json
email
string
requiredmemberId
string
requiredOnsi's ID of the member
firstName
string
requiredlastName
string
requiredphone
string | null
requiredtier
string
requiredTier name for the member
workerId
string | null
requiredUnique ID provided by API consumer, must be unique across all members (active, invited and inactive)
status
enum<string>
requiredThe status of the member.
Available options:
active
, invited
, inactive
accountDetails
object
requiredenablePayroll
boolean
required