Skip to main content
PATCH

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.

Path Parameters

​
groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

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

Body

application/json

The group fields. On PATCH, send only the fields you are changing.

​
external_id
string

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

Example:

"co_4821"

​
company_name
string
Example:

"Acme Inc"

​
legal_entity_name
string
Example:

"Acme Incorporated"

​
domain
string

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

Example:

"acme.com"

​
ein
string
Example:

"94-2404110"

​
address
object
​
contact
object
​
current_coverage
object

Optional historical coverage metadata. It is not required for market-rate quotes.

​
plan_design
object

What a carrier needs to know about the group's plan before it quotes. Every field is optional. On PATCH, send only the fields you are changing; a field sent as null is cleared.

Response

Updated group.

​
id
string
required
Example:

"grp_8c2f41d09a3e"

​
mode
enum<string>
required
Available options:
test,
live
​
status
enum<string>
required

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

Available options:
created,
census_received,
quoted,
enrolled,
active
​
company_name
string
required
Example:

"Acme Inc"

​
domain
string
required
Example:

"acme.com"

​
census_member_count
integer
required
Example:

12

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
legal_entity_name
string | null

Registered legal name, when you sent one.

​
external_id
string | null

Your internal employer ID.

Example:

"co_4821"

​
address
object | null
​
contact
object | null
​
current_coverage
object | null

Optional historical coverage metadata. It is not required for market-rate quotes.

​
plan_design
object

Present once you have set any plan design field.

​
move_forward
object

Present once the client's move-forward request was recorded with POST /groups/{groupId}/move-forward.

​
market_plans
integer

Brokers only. Always 0: plans sent in market_plans are no longer used.

​
enrollment
object

Present once the client's move-forward request was recorded: the carrier and plan to submit for enrollment, and where enrollment stands.

​
company_state
enum<string> | null

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

Available options:
sandbox,
prod,
null