API ReferenceGroup Policy Intents

Create a group policy intent

Creates a group_policy_intent from a group_quote_intent that has a quote available. The intent coordinates the policy setup workflow including requirements collection and policy creation.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request

This endpoint expects an object.
quote_intent_idstringRequiredformat: "gqi_.+"
Unique identifier for the group quote intent to create a policy intent from
cost_sharingobjectOptional
Cost sharing configuration override for the setup. If not provided, falls back to the quote intent's cost sharing.
consent_approvalslist of objects or nullOptional
Consent approvals to record at the time of intent creation

Response

OK
idstringformat: "gpi_.+"
Unique identifier for the group policy intent
group_idstring or nullformat: "gr_.+"

Unique identifier for the group. Null only on a multi-level intent, whose groups are on its levels.

plan_idstring or nullformat: "pl_.+"

Unique identifier for the plan. Null only on a multi-level intent, whose plans are on its levels.

quote_intent_idstringformat: "gqi_.+"
Unique identifier for the group quote intent this policy intent was created from
statusenum
Current status of the group policy intent
itemslist of objects

The benefits the accepted quote covers and the levels they were quoted at, echoed from the quote intent. Always present: a single intent echoes its group, plan and cost sharing as one item of one level, so a consumer reads one shape for both.

group_policy_idslist of strings

The group policies created for this intent, one per level, once they exist. Always present and empty until the intent reaches policy_created.

disclosureslist of objects
Disclosures associated with this intent.
typeenumOptional

Whether the accepted quote covers one (group, plan) pair or several levels. Absent or null means single, so readers of intents created before multi-level quoting need no migration. Always the type of the quote intent this policy intent accepts.

due_datedatetime or nullOptional
Due date for the policy intent
cost_sharingobjectOptional

Cost sharing configuration for the policy intent. Null on a multi-level intent, whose cost sharing is fixed per level at quote time.

action_requiredobjectOptional
Details of the required action when the intent is in ActionRequired status.
objectstringOptionalRead-only
Object type identifier

Errors

400
Bad Request Error
404
Not Found Error