Skip to main content
PUT
Replace the census

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
members
object[]
required

The full active census. Upsert key is email when present, else externalId. Max 10,000 members, 6 dependents each.

Maximum array length: 10000

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.

Response

Census processed. accepted rows are stored; errors lists rejected rows by index.

groupId
string
required
Example:

"grp_8c2f41d09a3e"

received
integer
required

Rows in the request.

Example:

12

accepted
integer
required

Rows stored.

Example:

12

memberCount
integer
required

Members on file after the replace.

Example:

12

errors
object[]
required

Per-row rejections. The row at index was not stored; everything else was.

warnings
string[]
required

Non-blocking issues, e.g. members missing email (required before enrollment, not for quoting).