Skip to main content
POST
Add a member

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Keys are stored hashed and cannot be recovered; store them in your secrets manager on issue.

Headers

Idempotency-Key
string

Any unique string (UUIDs work well). Replaying the same key within 24 hours returns the stored response instead of re-executing the request.

Maximum string length: 255

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

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

Body

application/json

One employee. zip plus one of dob | age is enough to quote. firstName, lastName, and email are additionally required (per active member) at enrollment time.

dob
string<date>
required
Example:

"1992-03-14"

zip
string
required

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

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

"94110"

externalId
string

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

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[]
Maximum array length: 6

Response

Member stored.

One employee. zip plus one of dob | age is enough to quote. firstName, lastName, and email are additionally required (per active member) at enrollment time.

dob
string<date>
required
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"

externalId
string

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

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[]
Maximum array length: 6