PATCH
/
v1
/
members
/
{id}

Updates an existing member, identified by their member_id.

Authorizations

X-API-KEY
string
headerrequired

Headers

x-idempotency-key
string

Unique key to ensure idempotency of the request

Path Parameters

id
string
required

The 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

A member on the platform.

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
Invite MemberRemove Member