Create Member

Defines a member in Clasp. Members are the primary policy holder (i.e., the employee receiving benefits).

POST /members

cURL

cURL

curl --request POST \
  --url https://sandbox.withclasp.com/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "employer": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "state": "AL",
    "zip_code": "<string>",
    "line2": "<string>"
  },
  "hire_date": "2023-12-25",
  "ssn": "<string>",
  "email": "[e-mail]",
  "phone_number": "<string>",
  "termination_date": "2023-12-25",
  "payroll_provider_external_id": "<string>",
  "biological_sex": "male",
  "hours_worked": "<string>",
  "pay_frequency": "weekly",
  "employment_status": "full_time",
  "subclasses": [
    "<string>"
  ],
  "business_unit": "<string>",
  "job_title": "<string>",
  "is_union": true,
  "is_seasonal": true
}
'

201

{
  "id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "2023-12-25",
  "employer": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "state": "AL",
    "zip_code": "<string>",
    "line2": "<string>"
  },
  "hire_date": "2023-12-25",
  "ssn_last_four": "<string>",
  "email": "[e-mail]",
  "phone_number": "<string>",
  "enrollments": [
    "<string>"
  ],
  "termination_date": "2023-12-25",
  "payroll_provider_external_id": "<string>",
  "biological_sex": "male",
  "hours_worked": "<string>",
  "pay_frequency": "weekly",
  "employment_status": "full_time",
  "subclasses": [
    "<string>"
  ],
  "business_unit": "<string>",
  "job_title": "<string>",
  "is_union": true,
  "is_seasonal": true
}

Authorizations

Authorization · string · header · required

API Key authentication with required prefix "Bearer"

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

Show child attributes

hire_date · string<date> · required

ssn · string

Pattern: \d{9}

email · string<email> | null

Maximum string length: 254

phone_number · string | null

Maximum string length: 10

termination_date · string<date> | null

payroll_provider_external_id · string | null

Maximum string length: 255

biological_sex · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• 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

Response

201 - application/json

id · string · required

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

Show child attributes

hire_date · string<date> · required

ssn_last_four · string

email · string<email> | null

Maximum string length: 254

phone_number · string | null

Maximum string length: 10

enrollments · string[]

termination_date · string<date> | null

payroll_provider_external_id · string | null

Maximum string length: 255

biological_sex · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• 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