--- schema_version: "1" id: 175239436c8285cafeb792a380d61f30ab9d492ac79eb4f3ddd9d9ed956b86b8 title: Insurance Group Benefits Business APIs collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/insurance_group_benefits_business_api_overview.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_business_api_overview.htm source_site: developer.salesforce.com content_type: documentation content_hash: 239127ca4124cbf404430e32d08da52ff9718115cd9045ee1cade13f34a37a38 description: Use the Group Benefits API resources to effectively manage the insurance plans offered to groups, such as employees and their dependents. --- # Insurance Group Benefits Business APIs 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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_accounts_create.htm "Create person accounts and portal users for group census members. The Person Account is used for linking to the appropriate policy for policy association, and the corresponding portal user is created to allow the member to log in to the community portal.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_create_contacts.htm "Create contacts and portal users for group census members. The Contact record is used for linking to the appropriate policy for policy association, and the corresponding portal user is created to allow the member to log in to the community portal.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_individual_members_rating.htm "Calculate pricing along with employee and employer contribution for individual members of a group census based on plan and coverages within the plan.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_census_management.htm "Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_census_management_delete.htm "Delete one or more census members of the specified group census ID.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_bulk_census_management.htm "Process group census data in bulk.") (POST) | Add, update, or delete group census members in bulk using an asynchronous batch job. | | [/connect/insurance/census-management/group-censuses/groupCensusId/sync-summary](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_census_summary_sync.htm "Synchronize and recalculate the summary data for a group census.") (POST) | Synchronize and recalculate the summary data for a group census. | | [/connect/insurance/census-management/group-census-members/memberId/plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_member_plans_management.htm "Create and update insurance plans for a group census member.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_delete_member_plans.htm "Delete specified plans for a group census member.") (POST) | Delete the specified plans for a group census member. | | [/connect/insurance/census-management/group-census-members/memberId/eligible-plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_member_eligible_plans.htm "Get the contract group plans for which a group census member and their dependents are eligible.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_invoke_enrollment_rules.htm "Evaluate product configuration rules for a group census member based on their selected plan and coverage options during initial enrollment (POST). Reevaluate plan eligibility for a group census member when plans are added or removed (PATCH).") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_contract_from_quote.htm "Create a group benefits contract from a quote. This API supports asynchronous operation for long-running conversions.") (POST) | Create a group benefits contract from a quote. Supports asynchronous operation for long-running conversions. | | [/connect/insurance/quotes/quoteId/group-rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_group_rating.htm "Rate a group benefits quote to calculate premiums for all quote line items. Rate specific root plans to calculate premiums for their associated quote line items.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_individual_enrollment.htm "Enroll a group census member along with their dependents in the specified group insurance plan and coverages, creating the necessary policy records (POST). Apply mid-term adjustment to manage new hires, terminations or benefits changes due to life events, such as birth, marriage, and promotions (PUT). For both the operations, use the standard flow that manages person account and contact creation, optional pricing, and policy creation or adjustment, or provide a custom flow based on your business needs.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_group_enrollment.htm "Enroll all members of a group census in their selected group benefit insurance plans as a single asynchronous bulk operation. The API response returns the ID of the bulk request so that you can track the enrollment job.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_deep_clone.htm "Clone a group census and its hierarchy, including members, member plans, and plan attributes. Use this API to copy one census data into another, apply field-level overrides, and optionally filter or remap member plan references. This API clones all reference data linked to the group census ID and supports field-level transformations to add to new values on existing data. You can apply filters to select the specific records to clone, such as filtering group census member plans by quote ID, and can use custom context definitions to include unique fields and specialized mappings.") (POST) | Clone a group census and its hierarchy, including members, member plans, and plan attributes. | | [/connect/insurance/contracts/contractId/actions/generate-census](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_generate_census_from_contract.htm "Generate a group census along with member and optional plan configuration from the active policies on an existing group benefits contract. You can optionally filter based on contract group plans, contacts, or person accounts. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_upsert_members.htm "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. You can optionally filter based on contract group plans, contacts, or person accounts. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_members_with_plans.htm "Add or update a family of group census members and their insurance plans in a group census. Use POST to add members and plans, and PATCH to update an existing family and the plans associated with those members.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_map_fields.htm "Map fields on existing member plans for a group census to the corresponding quote or contract records without creating new records. Use this resource to remap references from quote records to contract records, or from contract records back to quote records. This API lets you reuse the same census across the quote-to-contract lifecycle and vice versa. The API runs asynchronously and returns a request ID that you can use to track the job status.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_refresh_census.htm "Update a group census from policy enrollments and endorsements on an existing group benefits contract for a specified date range. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_quote_from_contract.htm "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.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote_line_item_overrides.htm "Apply, clone, or revert member-level plan and attribute overrides based on member configuration for quote line items corresponding to root products and coverages. Use POST to upsert overrides or to clone them from a source member to one or more target members. Use DELETE to revert overrides for a member.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_generate_contract_transactions.htm "Generate contract-level transaction details for a group benefits contract over a specified date range. The API groups existing policy transactions into InsuranceContractTrxn (header) and InsuranceContractTrxnDetail (line item) records. This API runs asynchronously and returns a job ID to track the job status.") (POST) | Generate contract-level transaction details for a group benefits contract over a specified date range. | | [/connect/insurance/group-censuses/censusId/price-comparisons](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_price_comparisons.htm "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. The comparison can cover a single product category or all product categories. You can also compare plan attributes by using this API. By default, the API returns the price comparison details. Set fetchAttributes to true to retrieve plan attribute differences instead of price comparison details.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_endorse_contract.htm "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 along with their associated attributes based on the finalized endorsement quote, and links both versions.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_contract.htm "Create a contract from a quote synchronously, along with contract group plans and attributes, based on the quote configuration for new business.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_renew_contract.htm "Create a renewed insurance contract from a renewal quote, carrying forward the applicable contract details and line items for the next coverage term.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_renew_policies.htm "Renew insurance policies of group census members for a contract renewal. This API creates insurance policies under the renewed contract for each primary census member in the specified group census, links the new policies to their previous policies, and records renewal transactions. The API runs asynchronously and returns a request ID that you can use to track the job status.") (POST) | Renew insurance policies of group census members for a contract renewal. | | [/connect/insurance/group-censuses/censusId/policies/member-plan-adjustment](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_member_plan_adjustment.htm "Apply mid-term adjustments to member policies in bulk to support new hires, terminations, or life events such as birth, marriage, or promotions. You can use the existing flow or provide a custom flow with custom actions. This API runs asynchronously and returns an ID to track the job.") (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](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_group_census_apply_contract_adjustment.htm "Apply mid-term contract adjustments to the eligible member policies. Use this resource after an endorsed contract version is created so that member policies reflect the contract changes. This API runs asynchronously and returns a request ID that you can use to track the job status.") (POST) | Apply mid-term contract adjustments to the eligible member policies after an endorsed contract version is created. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_business_apis_resources.htm)** Learn more about the available insurance group benefits API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_business_apis_requests.htm)** Learn more about the available requests of insurance group benefits APIs. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_business_apis_responses.htm)** Learn more about the available response bodies of insurance group benefits APIs.