Skip to main content
PUT

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.

Headers

Idempotency-Key
string

Any non-empty string; deterministic keys from your own IDs work best. Repeating the same key with the same body on the same endpoint and mode within 24 hours returns the stored successful response (with Idempotent-Replay: true) instead of re-executing. Error responses are not stored.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

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

Body

application/json

Send members, remove or both.

members
object[]

Members to add, or to update when one with the same external_id (else email) is on file. Same shape as in the full census.

One employee record. Include dependent elections when your platform has them; submitted dependents drive covered lives and household tiers. When they are unavailable, Prescience uses a disclosed normalized small-group household mix for the preliminary model.

remove
object[]

Members to remove, each by member_id, external_id or email.

Response

Edit applied.

group_id
string
required
Example:

"grp_8c2f41d09a3e"

received
integer
required

Rows in the request.

Example:

12

accepted
integer
required

Rows stored.

Example:

12

member_count
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).

removed
integer
required

Members removed.

not_found
integer[]
required

Positions in remove that matched no member.