Skip to main content
PATCH
Update or terminate a member

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$
memberId
string
required

Census member ID, e.g. mem_92e4b7a1d0c6.

Pattern: ^mem_[0-9a-f]{12}$

Body

application/json

Partial update: send only the fields you are changing. Terminate with status: "terminated" and terminationDate; add cobra: true, coverageLossDate, and the mailing address to offer COBRA.

externalId
string

Your payroll's employee ID (Check Employee.id). Required at enrollment; the upsert key, and how payroll results find the employee.

Example:

"emp_0001"

firstName
string
Example:

"Jordan"

lastName
string
Example:

"Reyes"

email
string<email>

Upsert key when present.

Example:

"jordan@acme.com"

dob
string<date>
Example:

"1992-03-14"

age
integer

Alternative to dob. One of the two is required.

Example:

34

zip
string

5-digit home ZIP. Drives the area factor in rating.

Pattern: ^[0-9]{5}$
Example:

"94110"

sexAtBirth
enum<string>
Available options:
male,
female,
other
employmentType
enum<string>
Available options:
full_time,
part_time,
contractor
hireDate
string<date>
Example:

"2024-03-01"

status
enum<string>
default:active
Available options:
active,
terminated
terminationDate
string<date>
Example:

"2026-11-15"

cobra
boolean

Offer COBRA continuation on termination. With status: "terminated", requires terminationDate, coverageLossDate, and the full mailing address.

coverageLossDate
string<date>

Last day of employer coverage. Required for a COBRA termination.

Example:

"2026-11-30"

qualifyingEventType
enum<string>
default:termination
Available options:
termination,
hours_reduction,
employee_death
personalEmail
string<email>

Optional non-work address for COBRA notices. Must not be on the employee's work email domain.

mailingAddressLine1
string

Household mailing address. Required for a COBRA termination, with mailingCity, mailingState, and mailingPostalCode.

mailingCity
string
mailingState
string
Example:

"CA"

mailingPostalCode
string
Example:

"94110"

Response

Updated member.

Partial update: send only the fields you are changing. Terminate with status: "terminated" and terminationDate; add cobra: true, coverageLossDate, and the mailing address to offer COBRA.

dob
string<date>
required

Required for every employee and dependent of a broker; a broker's member sent with only an age is rejected.

Example:

"1992-03-14"

zip
string
required

5-digit home ZIP. Drives the area factor in rating.

Pattern: ^[0-9]{5}$
Example:

"94110"

memberId
string
required

Server-assigned ID. Use it for PATCH /groups/{groupId}/members/{memberId}.

Example:

"mem_c4a91f27e83d"

createdAt
string<date-time>
required
externalId
string

Your payroll's employee ID (Check Employee.id). Required at enrollment; the upsert key, and how payroll results find the employee.

Example:

"emp_0001"

firstName
string
Example:

"Jordan"

lastName
string
Example:

"Reyes"

email
string<email>

Upsert key when present.

Example:

"jordan@acme.com"

age
integer

Alternative to dob. One of the two is required.

Example:

34

sexAtBirth
enum<string>
Available options:
male,
female,
other
employmentType
enum<string>
Available options:
full_time,
part_time,
contractor
hireDate
string<date>
Example:

"2024-03-01"

status
enum<string>
default:active
Available options:
active,
terminated
dependents
object[]

Optional household members already known to your platform.

Maximum array length: 6
terminationDate
string<date>
Example:

"2026-11-15"

cobra
boolean

Offer COBRA continuation on termination. With status: "terminated", requires terminationDate, coverageLossDate, and the full mailing address.

coverageLossDate
string<date>

Last day of employer coverage. Required for a COBRA termination.

Example:

"2026-11-30"

qualifyingEventType
enum<string>
default:termination
Available options:
termination,
hours_reduction,
employee_death
personalEmail
string<email>

Optional non-work address for COBRA notices. Must not be on the employee's work email domain.

mailingAddressLine1
string

Household mailing address. Required for a COBRA termination, with mailingCity, mailingState, and mailingPostalCode.

mailingCity
string
mailingState
string
Example:

"CA"

mailingPostalCode
string
Example:

"94110"

excludedFromQuote
boolean

true when the employer marked this employee as waiving coverage in the iframe. They stay on the census.

waiverReason
string

Why the employee waived, when excludedFromQuote is true.

waiverNote
string
updatedAt
string<date-time>