Skip to main content
PATCH
/
members
/
{public_id}
cURL
curl --request PATCH \
  --url https://sandbox.withclasp.com/members/{public_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "ssn": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "employer": "<string>",
  "hire_date": "2023-12-25",
  "termination_date": "2023-12-25",
  "payroll_provider_external_id": "<string>",
  "hours_worked": "<string>",
  "subclasses": [
    "<string>"
  ],
  "business_unit": "<string>",
  "job_title": "<string>",
  "is_union": true,
  "is_seasonal": true,
  "metadata": {}
}
'
{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "employer": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "zip_code": "<string>",
    "line2": "<string>"
  },
  "hire_date": "2023-12-25",
  "middle_name": "<string>",
  "ssn_last_four": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "enrollments": [
    "<string>"
  ],
  "termination_date": "2023-12-25",
  "payroll_provider_external_id": "<string>",
  "hours_worked": "<string>",
  "subclasses": [
    "<string>"
  ],
  "business_unit": "<string>",
  "job_title": "<string>",
  "is_union": true,
  "is_seasonal": true,
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.withclasp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

​
public_id
string
required

Body

​
first_name
string
Maximum string length: 255
​
middle_name
string | null
Maximum string length: 255
​
last_name
string
Maximum string length: 255
​
dob
string<date>
​
ssn
string
write-only
Pattern: \d{9}
​
email
string<email> | null
Maximum string length: 254
​
phone_number
string | null
Maximum string length: 10
​
employer
string
​
address
object
​
hire_date
string<date>
​
termination_date
string<date> | null
​
payroll_provider_external_id
string | null
Maximum string length: 255
​
biological_sex
  • male - Male
  • female - Female
Available options:
male,
female
​
hours_worked
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
​
pay_frequency
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
​
employment_status
enum<string>
  • full_time - Full Time
  • part_time - Part Time
  • variable_hours - Variable Hours
Available options:
full_time,
part_time,
variable_hours
​
subclasses
string[]
​
business_unit
string | null
​
job_title
string | null
Maximum string length: 255
​
is_union
boolean | null

Whether the employee is a union member

​
is_seasonal
boolean | null

Whether the employee is seasonal

​
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.

Response

200 - application/json
​
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
​
first_name
string
required
Maximum string length: 255
​
last_name
string
required
Maximum string length: 255
​
dob
string<date>
required
​
employer
string
required
​
address
object
required
​
hire_date
string<date>
required
​
middle_name
string | null
Maximum string length: 255
​
ssn_last_four
string
read-only
​
email
string<email> | null
Maximum string length: 254
​
phone_number
string | null
Maximum string length: 10
​
enrollments
string[]
read-only
​
termination_date
string<date> | null
​
payroll_provider_external_id
string | null
Maximum string length: 255
​
biological_sex
  • male - Male
  • female - Female
Available options:
male,
female
​
hours_worked
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
​
pay_frequency
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
​
employment_status
enum<string>
  • full_time - Full Time
  • part_time - Part Time
  • variable_hours - Variable Hours
Available options:
full_time,
part_time,
variable_hours
​
subclasses
string[]
​
business_unit
string | null
​
job_title
string | null
Maximum string length: 255
​
is_union
boolean | null

Whether the employee is a union member

​
is_seasonal
boolean | null

Whether the employee is seasonal

​
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.