PATCH
/
v1
/
members
/
{id}
curl --request PATCH \
  --url https://api.onsi.com/v1/members/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "workerId": "ID_123",
  "tier": "<string>",
  "accountDetails": {
    "accountHolder": "John Smith",
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "enablePayroll": true,
  "dob": "1990-01-01",
  "gender": "Female"
}'
{
  "email": "jsmith@example.com",
  "memberId": "mem_q5sdae3se6eg9m9dcvug",
  "firstName": "John",
  "lastName": "Smith",
  "phone": "+447123456789",
  "tier": "Gold",
  "workerId": "ID_123",
  "status": "active",
  "accountDetails": {
    "accountHolder": "John Smith",
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "enablePayroll": true,
  "gender": "Female",
  "dob": "1990-01-01"
}

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_

Example:

"mem_<id>"

Body

application/json

Body

The body is of type object.

Response

200 - application/json

200

A member on the platform.