Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Body

first_name
string
middle_name
string | null
Maximum string length: 255
last_name
string
member
string
member_relationship
enum<string>
  • spouse - Spouse
  • domestic_partner - Domestic Partner
  • civil_union - Civil Union
  • ex_spouse - Ex Spouse
  • child - Child
  • grandchild - Grandchild
  • step_child - Step Child
  • foster_child - Foster Child
  • adopted_child - Adopted Child
  • legal_guardianship - Legal Guardianship
  • court_ordered_dependent - Court Ordered Dependent
  • other - Other
Available options:
spouse,
domestic_partner,
civil_union,
ex_spouse,
child,
grandchild,
step_child,
foster_child,
adopted_child,
legal_guardianship,
court_ordered_dependent,
other
ssn
string
write-only
Pattern: \d{9}
dob
string<date>
biological_sex
enum<string>
  • male - Male
  • female - Female
Available options:
male,
female
has_disability
boolean
address
object
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
last_name
string
required
member
string
required
member_relationship
enum<string>
required
  • spouse - Spouse
  • domestic_partner - Domestic Partner
  • civil_union - Civil Union
  • ex_spouse - Ex Spouse
  • child - Child
  • grandchild - Grandchild
  • step_child - Step Child
  • foster_child - Foster Child
  • adopted_child - Adopted Child
  • legal_guardianship - Legal Guardianship
  • court_ordered_dependent - Court Ordered Dependent
  • other - Other
Available options:
spouse,
domestic_partner,
civil_union,
ex_spouse,
child,
grandchild,
step_child,
foster_child,
adopted_child,
legal_guardianship,
court_ordered_dependent,
other
ssn_last_four
string
required
read-only
dob
string<date>
required
biological_sex
enum<string>
required
  • male - Male
  • female - Female
Available options:
male,
female
address
object
required
enrolled_plans
string[]
required
read-only
middle_name
string | null
Maximum string length: 255
has_disability
boolean
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.