PATCH
/
v1
/
members
/
{id}

Updates an existing member, identified by their memberId.

Relevant Error Codes

If there are any issues with the update, the API will return a 400 status code with the following error codes:

Authorizations

X-API-KEY
string
header
required

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
accountDetails
object
email
string

This can only be changed if member status is invited

enablePayroll
boolean
firstName
string

First name of the member

lastName
string

Last name of the member

phone
string

Phone number

tier
string

Tier name

workerId
string | null

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

Response

200 - application/json

A member on the platform.

accountDetails
object
required
email
string
required
enablePayroll
boolean
required
firstName
string
required
lastName
string
required
memberId
string
required

Onsi's ID of the member

phone
string | null
required
status
enum<string>
required

The status of the member.

Available options:
active,
invited,
inactive
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)