Create a group quote intent
Creates a group_quote_intent to request a quote for a group and plan combination, or for several (group, plan) levels of one benefit quoted together as items. The intent coordinates the quote workflow including requirements collection and quote generation.
Authentication
Headers
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
Unique identifier for the group to get a quote for. Required unless items is supplied.
Unique identifier for the plan to get a quote for. Required unless items is supplied.
Cost sharing configuration for the quote. Required, and settled here rather than at acceptance: the group policy intent takes no cost sharing of its own. Not accepted alongside items, which carries cost sharing per level.
Plan coverage option selections for group-policy-scoped configurations. Not accepted alongside items, which carries coverage selections per level.
The benefits to quote, each with its own levels. Supplying this opts into the multi-level shape: group_id, plan_id, cost_sharing and coverage_selections must then be omitted. Exactly one item is allowed.
Response
Unique identifier for the group. Null only on a multi-level intent, whose groups are on its levels.
Unique identifier for the plan. Null only on a multi-level intent, whose plans are on its levels.
The benefits this intent quotes and the levels they are quoted at. 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.
The statements the customer must accept to proceed, each a sentence and the documents it names. Display them in the order given, each with its own acceptance, and submit every one back on consent_approvals when creating the group policy intent. A statement carries no type: it can bundle several documents, so its id identifies it instead. Empty until statements are configured.
Disclosures associated with this intent. On a multi-level intent, the deduplicated union across its levels’ plans.
Whether the intent quotes one (group, plan) pair or several levels. Absent or null means single, so readers of intents created before multi-level quoting need no migration.
Cost sharing configuration for the quote. Null on a multi-level intent, whose cost sharing is per level.
Details of the action required from the caller, if the intent is in action_required status.