Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Census

Update or terminate a member

Updates member fields. Terminate with { "status": "terminated", "terminationDate": "...", "cobra": true }. After enrollment, changes propagate to the live company census; cobra: true keeps the member covered under COBRA continuation.

patch/groups/{groupId}/members/{memberId}

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

memberIdstring required

Census member ID, e.g. mem_92e4b7a1d0c6.

Request body

externalIdstring

Your employee ID. Used as the upsert key when email is absent.

firstNamestring
lastNamestring
emailstring email

Upsert key when present.

dobstring date
ageinteger

Alternative to dob. One of the two is required.

zipstring

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

sexAtBirth'male' | 'female' | 'other'
employmentType'full_time' | 'part_time' | 'contractor'
hireDatestring date
status'active' | 'terminated'
terminationDatestring date
cobraboolean

Offer COBRA continuation on termination.

Example request

{
  "externalId": "emp_0001",
  "firstName": "Jordan",
  "lastName": "Reyes",
  "email": "jordan@acme.com",
  "dob": "1992-03-14",
  "age": 34,
  "zip": "94110",
  "hireDate": "2024-03-01",
  "dependents": [
    {
      "dob": "2019-10-02",
      "name": "Mia Fischer"
    }
  ],
  "terminationDate": "2026-11-15"
}

Response

Updated member.

OR

Example response

{
  "memberId": "mem_c4a91f27e83d"
}