Use the Group Benefits API resources to effectively manage the insurance plans offered
to groups, such as employees and their dependents.
Available in: Lightning Experience
Available in: Professional, Enterprise, and Unlimited Editions of Digital Insurance with Digital Insurance Product Admin Add On, Digital Insurance Group Benefits AddOn, Digital Insurance Group Enrollment AddOn,Digital Insurance Group Benefits Customer Community AddOn, and Digital Insurance Group Benefits Partner Community AddOn licenses
This table lists the available Insurance Group Benefits resources.
| Resource | Description |
|---|---|
| /connect/insurance/accounts (POST) | Create person accounts and portal users for group census members so that members can be linked to their policies and can log in to the community portal. |
| /connect/insurance/contacts (POST) | Create contacts and portal users for group census members so that members can be linked to their policies and can log in to the community portal. |
| /connect/insurance/group-census-members/memberId/action/rate (POST) | Calculate pricing and employee and employer contributions for an individual group census member based on the plan and coverages within the plan. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members (POST, PATCH, DELETE) | Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members/delete (POST) | Delete one or more census members of the specified group census ID. |
| /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members/bulk-process (POST) | Add, update, or delete group census members in bulk using an asynchronous batch job. |
| /connect/insurance/census-management/group-censuses/groupCensusId/sync-summary (POST) | Synchronize and recalculate the summary data for a group census. |
| /connect/insurance/census-management/group-census-members/memberId/plans (POST, PATCH) | Create (POST) and update (PATCH) insurance plans for a group census member. |
| /connect/insurance/census-management/group-census-members/memberId/plans/action/delete (POST) | Delete the specified plans for a group census member. |
| /connect/insurance/census-management/group-census-members/memberId/eligible-plans (GET) | Get the contract group plans for which a group census member and their dependents are eligible. |
| /connect/insurance/census-management/group-census-members/memberId/enrollment-rules/actions/invoke (POST, PATCH) | Evaluate product configuration rules for a group census member based on the selected plan and coverage options during initial enrollment (POST). Reevaluate plan eligibility for a group census member when plans are added or removed (PATCH). |
| /connect/insurance/contracts (POST) | Create a group benefits contract from a quote. Supports asynchronous operation for long-running conversions. |
| /connect/insurance/quotes/quoteId/group-rating (POST) | Rate a group benefits quote to calculate premiums for all quote line items, or rate specific root plans to calculate premiums for their associated quote line items. |
| /connect/insurance/group-census-members/memberId/policies (POST, PUT) | Enroll a group census member in a group benefit insurance plan, creating the necessary policy records (POST). Apply a mid-term adjustment to the member's existing policies (PUT). |
| /connect/insurance/group-censuses/censusId/policies (POST) | Enroll all members of a group census in their selected group benefit insurance plans as a single asynchronous bulk operation. |
| /connect/insurance/group-censuses/censusId/actions/deep-clone (POST) | Clone a group census and its hierarchy, including members, member plans, and plan attributes. |
| /connect/insurance/contracts/contractId/actions/generate-census (POST) | Generate a group census along with member and optional plan configuration from the active policies on an existing group benefits contract. |
| /connect/insurance/contracts/contractId/actions/upsert-members (POST) | Update a group census with member and optional plan configuration from the active policies on an existing group benefits contract for changes after the last census generation. |
| /connect/insurance/group-censuses/censusId/members-with-plans (POST, PATCH) | Add or update a family of group census members and their insurance plans in a group census. |
| /connect/insurance/group-censuses/censusId/actions/map-fields (POST) | Map fields on existing member plans for a group census to the corresponding quote or contract records without creating new records. |
| /connect/insurance/contracts/contractId/actions/refresh-census (PATCH) | Update a group census from policy enrollments and endorsements on an existing group benefits contract for a specified date range. |
| /connect/insurance/contracts/contractId/actions/generate-quote (POST) | Create an endorsement or renewal quote from an existing group benefits contract, including the quote structure and line items, without re-entering contract details manually. |
| /connect/insurance/quote-line-items/rootQliId/overrides (POST, DELETE) | Apply, clone, or revert member-level plan and attribute overrides based on member configuration for quote line items corresponding to root products and coverages. |
| /connect/insurance/contracts/contractId/actions/generate-transactions (POST) | Generate contract-level transaction details for a group benefits contract over a specified date range. |
| /connect/insurance/group-censuses/censusId/price-comparisons (POST) | Compare the previous and the current cost for a group census for one member and its associated dependents, or the summary for the entire census, to view the impact of enrollment, adjustment, or renewal before it's finalized. |
| /connect/insurance/contracts/actions/endorse (POST) | Create an endorsed contract version from a quote for mid-term adjustments. This API shortens the existing contract, creates a new version of the contract and contract group plan records, and links both versions. |
| /connect/insurance/contracts/actions/issue (POST) | Create a contract from a quote synchronously, along with contract group plans and attributes, based on the quote configuration for new business. |
| /connect/insurance/contracts/actions/renew (POST) | Create a renewed insurance contract from a renewal quote, carrying forward the applicable contract details and line items for the next coverage term. |
| /connect/insurance/group-censuses/censusId/policies/actions/renew (POST) | Renew insurance policies of group census members for a contract renewal. |
| /connect/insurance/group-censuses/censusId/policies/member-plan-adjustment (POST) | Apply mid-term adjustments to member policies in bulk to support new hires, terminations, or life events such as birth, marriage, or promotions. |
| /connect/insurance/group-censuses/censusId/policies/actions/apply-contract-adjustment (POST) | Apply mid-term contract adjustments to the eligible member policies after an endorsed contract version is created. |