Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Groups

Update a group

Updates writable group fields (same fields as create).

patch/groups/{groupId}

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

Request body

externalIdstring

Your internal employer ID. Echoed back on the group and useful for reconciliation.

companyNamestring required
legalEntityNamestring
domainstring required

Primary company domain. One enrolled group per domain per mode.

einstring

Example request

{
  "externalId": "co_4821",
  "companyName": "Acme Inc",
  "legalEntityName": "Acme Incorporated",
  "domain": "acme.com",
  "ein": "94-2404110",
  "address": {
    "line1": "548 Market St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104"
  },
  "contact": {
    "name": "Dana Park",
    "email": "dana@acme.com",
    "title": "Head of People"
  },
  "currentCoverage": {
    "planType": "fully_insured",
    "carrier": "Anthem",
    "pepmCents": 80000,
    "renewalDate": "2026-09-01"
  }
}

Response

Updated group.

idstring required
mode'test' | 'live' required
status'created' | 'census_received' | 'quoted' | 'enrolled' | 'active' required

Lifecycle: created -> census_received -> quoted -> enrolled -> active (active = company flipped to prod by Prescience).

companyNamestring required
domainstring required
externalIdstring nullable

Your internal employer ID.

censusMemberCountinteger required
companyState'sandbox' | 'prod' | 'null' nullable

null until enrolled, then sandbox, then prod once Prescience activates the group.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "grp_8c2f41d09a3e",
  "companyName": "Acme Inc",
  "domain": "acme.com",
  "externalId": "co_4821",
  "address": {
    "line1": "548 Market St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104"
  },
  "contact": {
    "name": "Dana Park",
    "email": "dana@acme.com",
    "title": "Head of People"
  },
  "currentCoverage": {
    "planType": "fully_insured",
    "carrier": "Anthem",
    "pepmCents": 80000,
    "renewalDate": "2026-09-01"
  },
  "censusMemberCount": 12
}