# legacydeveloper Insurance Developer Guide - Full Documentation # Add Eligible Insurance Clauses Action Add eligible insurance clauses to a quote or context. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID along with insurance product clause details. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/addEligibleInsuranceClauses Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contextId | string | Required if quoteId isn't specified. Context ID of the insurance quote. | | instanceKey | string | Required if quoteLineItemId isn't specified. Unique key that identifies the product to which a quote line item belongs. | | insuranceProductClauses | string | Required. JSON object with the details of the insurance product clauses to add. | | optionFlags | Apex-defined | An Apex [runtime\_industries\_insurance.AddEligibleInsuranceClausesOptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm "HTML (New Window)") record that contains the details to add eligible clauses to an insurance product. | | quoteId | string | Required if contextId isn't specified. ID of the insurance quote to add eligible clauses. | | quoteLineItemId | string | Required if instanceKey isn't specified. ID of the quote line items for adding eligible clauses. | ## Outputs | Output | Type | Description | | --- | --- | --- | | errorsList | string | Errors that are encountered during the operation. | | isSuccess | boolean | Indicates whether the operation is successful ( true ) or not ( false ). | | quoteLineItemInsProductClauseIds | string | IDs of the quote line item insurance product clauses. | ## Example Sample Request { "inputs": \[ { "quoteId": "0Q0xx0000000001AAA", "quoteLineItemId": "0QLxx0000000002BBB", "contextId": "0j5xx0000000003CCC", "instanceKey": \[ "Auto", "Liability" \], "insuranceProductClauses": \[ { "insuranceProductClauseId": "0j4xx0000000004DDD", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31" } \], "optionFlags": { "saveContext": true } } \] } This is a sample request to call this invocable action from Apex code. public class AddEligibleInsuranceClausesInvoke { private static final String ACTION\_NAME = 'addEligibleInsuranceClauses'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Either quoteId or contextId is required setInvocationParameter(action, inputs, 'quoteId', false); setInvocationParameter(action, inputs, 'contextId', false); // Either quoteLineItemId or instanceKey is required setInvocationParameter(action, inputs, 'quoteLineItemId', false); setInvocationParameter(action, inputs, 'instanceKey', false); // insuranceProductClauses expects JSON setInvocationParameter(action, inputs, 'insuranceProductClauses', true); // Optional optionFlags map if (inputs != null && inputs.containsKey('optionFlags')) { Map addClauseOptions = (Map) inputs.get('optionFlags'); if (addClauseOptions != null) { runtime\_industries\_insurance.AddEligibleInsuranceClausesOptions apexOptions = new runtime\_industries\_insurance.AddEligibleInsuranceClausesOptions(); if (addClauseOptions.containsKey('saveContext')) { apexOptions.SaveContext = (Boolean) addClauseOptions.get('saveContext'); } action.setInvocationParameter('addClauseOptions', apexOptions); } } List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } Sample Response \[ { "actionName": "addEligibleInsuranceClauses", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "isSuccess": true, "quoteLineItemInsProductClauseIds": \[ "a1Cxx0000000001AAA" \], "errorsList": \[\] }, "sortOrder": -1, "version": 1 } \] # Add Eligible Product Clause Input Input representation for adding eligible product clauses. ## JSON Example { "quoteId": "0Q0xx0000000001AAA", "quoteLineItemId": "0QLxx0000000002BBB", "contextId": "0j5xx0000000003CCC", "instanceKey": \["Auto", "Liability"\], "insuranceProductClauses": \[ { "insuranceProductClauseId": "0j4xx0000000004DDD", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31" } \], "options": { "saveContext": false } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context. | Required if quoteId isn't specified | 65.0 | | instanceKey | String\[\] | List of product instance IDs from the root product to the target quote line item. | Required if quoteLineItemId isn't specified | 65.0 | | insurance​Product​Clauses | [Insurance Product Clause Input\[\]](connect_requests_insurance_product_clause_input.htm "Input representation for a single insurance product clause.") | List of insurance product clauses to add. | Required | 65.0 | | options | [Add Eligible Product Clauses Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_add_eligible_product_clauses_options_input.htm "Input representation for options when adding eligible product clauses.") | Options for adding eligible product clauses. | Optional | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quoteLine​ItemId | String | ID of the quote line item. | Required if instanceKey isn't specified | 65.0 | # Add Eligible Product Clause Options Input Input representation for options when adding eligible product clauses. ## JSON Example { "saveContext": false } ## Properties
Name Type Description Required or Optional Available Version
saveContext Boolean Indicates whether to save the context (true) or not (false).

The default value is false.

 Optional 65.0
# Add Eligible Product Clauses Details Output representation for adding eligible product clauses. ## JSON Example { "success": true, "quoteLineItemInsProductClauseIds": \[ "a1Cxx0000000001AAA" \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Product Clause Error\[\]](connect_responses_insurance_product_clause_error.htm "Output representation of an error that occurred during the product clause operation.") | List of errors that occurred during processing. | Big, 65.0 | 65.0 | | quoteLineItem​InsProduct​ClauseIds | String\[\] | List of unique IDs for all insurance product clauses that are created for the specified quote line item | Big, 65.0 | 65.0 | | success | Boolean | Indicates whether the operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # AddEligibleInsuranceClausesOptions Class Contains options for adding eligible product clauses to an insurance product. Use this class when configuring which clauses, such as exclusions or coverage terms, are available for selection on an insurance product. ## Namespace [runtime\_industries\_insurance](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm "The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.") ## Usage Use the AddEligibleInsuranceClausesOptions class with the [Add Eligible Insurance Clauses](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_add_eligible_insurance_clauses.htm) invocable action to add eligible insurance clauses. ## Example When calling the [Add Eligible Insurance Clauses](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_add_eligible_insurance_clauses.htm) invocable action from Apex, create an AddEligibleInsuranceClausesOptions instance and set the properties, then use it as addClauseOptions. // Optional optionFlags for addEligibleInsuranceClauses if (inputs != null && inputs.containsKey('optionFlags')) { Map addClauseOptions = (Map) inputs.get('optionFlags'); if (addClauseOptions != null) { runtime\_industries\_insurance.AddEligibleInsuranceClausesOptions addClauseApexOptions = new runtime\_industries\_insurance.AddEligibleInsuranceClausesOptions(); if (addClauseOptions.containsKey('saveContext')) { addClauseApexOptions.saveContext = (Boolean) addClauseOptions.get('saveContext'); } action.setInvocationParameter('addClauseOptions', addClauseApexOptions); } } - **[AddEligibleInsuranceClausesOptions Constructors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_runtime_industries_insurance_AddEligibleInsuranceClausesOptions_constructors)** Learn more about the constructors that are available with the AddEligibleInsuranceClausesOptions class. - **[AddEligibleInsuranceClausesOptions Properties](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_runtime_industries_insurance_AddEligibleInsuranceClausesOptions_properties)** Set the AddEligibleInsuranceClausesOptions class property to save the context of a quote. ## AddEligibleInsuranceClausesOptions Constructors Learn more about the constructors that are available with the AddEligibleInsuranceClausesOptions class. The AddEligibleInsuranceClausesOptions class includes these constructors. - **[AddEligibleInsuranceClausesOptions(saveContext)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_runtime_industries_insurance_AddEligibleInsuranceClausesOptions_ctor)** Creates an options instance with the specified context-saving behavior for adding eligible insurance clauses. - **[AddEligibleInsuranceClausesOptions()](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_runtime_industries_insurance_AddEligibleInsuranceClausesOptions_ctor_2)** Creates an options instance with default settings for adding eligible insurance clauses. Context is not saved by default. ### AddEligibleInsuranceClausesOptions(saveContext) Creates an options instance with the specified context-saving behavior for adding eligible insurance clauses. #### Signature public AddEligibleInsuranceClausesOptions(Boolean saveContext) #### Parameters **saveContext** - **Type**: Boolean - Indicates whether to save the operation context when adding eligible insurance clauses (true) or not (false). - The default value is true. ### AddEligibleInsuranceClausesOptions() Creates an options instance with default settings for adding eligible insurance clauses. Context is not saved by default. #### Signature public AddEligibleInsuranceClausesOptions() ## AddEligibleInsuranceClausesOptions Properties Set the AddEligibleInsuranceClausesOptions class property to save the context of a quote. The AddEligibleInsuranceClausesOptions class includes this property. - **[saveContext](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_runtime_industries_insurance_AddEligibleInsuranceClausesOptions_saveContext)** Indicates whether to save the operation context when adding eligible insurance clauses (true) or not (false). ### saveContext Indicates whether to save the operation context when adding eligible insurance clauses (true) or not (false). #### Signature public Boolean saveContext {get; set;} #### Property Value Type: Boolean # Additional Fields Field Set Input Input representation for the list of the field set IDs for asset, coverage, participant, and policy objects. ## JSON Example { "policyFieldSetId": "0IXxx0000004CYqGAM", "assetFieldSetId": "0IXxx0000004CaSGAU", "participantFieldSetId": "0IXxx0000004CdgGAE", "coverageFieldSetId": "0IXxx0000004Cc4GAE" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetField​SetId | String | ID of the field set to get the fields that are associated with the asset object. | Optional | 65.0 | | coverageField​SetId | String | ID of the field set to get the fields that are associated with the coverage object. | Optional | 65.0 | | participant​FieldSetId | String | ID of the field set to get the fields that are associated with the participant object. | Optional | 65.0 | | policy​FieldSetId | String | ID of the field set to get the fields that are associated with the policy object. | Optional | 65.0 | # Additional Fields Map Value Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap. ## JSON Example additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } } { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields​MapValue | Object | JSON map that contains the fields to be updated. | Required | 63.0 | # Additional Fields Map Value Input representation for additional fields map value. ## JSON Example { "key": "EmployeeNumber\_\_c", "value": "E12345" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​FieldsMapValue | Object | Key-value pairs for populating custom fields or other fields. | Optional | 65.0 | # addMembersWithPlans(membersWithPlansInputRepresentation, censusId) Add a family of group census members and their insurance plans to a group census in a single request. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.MembersWithPlansRepresentation addMembersWithPlans(ConnectApi.MembersWithPlansInputRepresentation membersWithPlansInputRepresentation, String censusId) ## Parameters **membersWithPlansInputRepresentation** - Type: [ConnectApi.MembersWithPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_members_with_plans.htm "Input representation for adding or updating a family of group census members and their insurance plans.") - Details of the members to add, the insurance plans to assign to each member, and the flow and duplicate detection settings to use while the members are processed. **censusId** - Type: String - ID of the group census to add the members to. ## Return Value Type: [ConnectApi.MembersWithPlansRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_members_with_plans.htm "Output representation that's returned when you add or update a family of group census members and their insurance plans.") ## Usage Use this method to add a family of group census members, along with the insurance plans for each member, to a group census in a single call. Specify the group census in censusId and the members in the members property of the input representation. For each member, specify name. Specify the member's plans in groupCensusMemberPlans. The addedPlans, upsertedPlans, and deletedPlans properties apply only when you update members with [updateMembersWithPlans(membersWithPlansInputRepresentation, censusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_updateMembersWithPlans.htm "Update a family of group census members and their insurance plans in a group census in a single request."). To relate a dependent to a primary member, set the dependent's primaryGroupCensusMemberId and associationWithPrimaryMbr properties. For each plan, specify either contractGroupPlanId for a plan on the census's contract, or productCode and rootProductCode for an off-contract coverage. Members are checked for duplicates by using the FirstName, LastName, AssociationWithPrimaryMbr, Email, and GroupCensusId fields. To include more fields in the duplicate check, specify their API names in duplicateDetectionFields. Check the isSuccess property of the response to determine whether the operation succeeded. Request-level errors are in the top-level errors property, which is empty when isSuccess is true. Member-specific errors are in the errors property of each item in members. ## Example Here's an example of how to add a primary group census member and a dependent, each with their insurance plans, from Apex code. When you add a member, don't set the id property, and specify the member's plans in groupCensusMemberPlans. // Add group census members and their insurance plans in a single call. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String GROUP\_CLASS\_ID = '0rExx000000004uEAA'; final String CGP\_1 = '0rgxx00000001W4AAI'; final String CGP\_2 = '0rgxx00000001W3AAI'; // 1) Build the plans for the primary member. ConnectApi.MemberPlanInputRepresentation primaryPlan1 = new ConnectApi.MemberPlanInputRepresentation(); primaryPlan1.contractGroupPlanId = CGP\_1; ConnectApi.MemberPlanInputRepresentation primaryPlan2 = new ConnectApi.MemberPlanInputRepresentation(); primaryPlan2.contractGroupPlanId = CGP\_2; // 2) Build the primary member. ConnectApi.MemberWithPlansInputRepresentation primary = new ConnectApi.MemberWithPlansInputRepresentation(); primary.name = 'Apex AddTest Primary'; primary.firstName = 'ApexAdd'; primary.lastname = 'Primary'; primary.associationWithPrimaryMbr = 'Self'; primary.memberType = 'Primary'; primary.birthdate = '1988-03-10'; primary.gender = 'Male'; primary.email = 'apexadd.primary@example.com'; primary.groupClassId = GROUP\_CLASS\_ID; primary.isOptOutAllPlans = false; primary.isPortalUser = false; primary.groupCensusMemberPlans = new List{ primaryPlan1, primaryPlan2 }; // 3) Build a dependent of the primary member. ConnectApi.MemberPlanInputRepresentation dependentPlan = new ConnectApi.MemberPlanInputRepresentation(); dependentPlan.contractGroupPlanId = CGP\_1; ConnectApi.MemberWithPlansInputRepresentation dependent = new ConnectApi.MemberWithPlansInputRepresentation(); dependent.name = 'Apex AddTest Spouse'; dependent.firstName = 'ApexAdd'; dependent.lastname = 'Spouse'; dependent.associationWithPrimaryMbr = 'Spouse'; dependent.memberType = 'Dependent'; dependent.birthdate = '1990-07-22'; dependent.gender = 'Female'; dependent.groupClassId = GROUP\_CLASS\_ID; dependent.isOptOutAllPlans = false; dependent.isPortalUser = false; dependent.groupCensusMemberPlans = new List{ dependentPlan }; // 4) Add both members to the group census. ConnectApi.MembersWithPlansInputRepresentation input = new ConnectApi.MembersWithPlansInputRepresentation(); input.members = new List{ primary, dependent }; try { ConnectApi.MembersWithPlansRepresentation result = ConnectApi.GroupBenefitsApi.addMembersWithPlans(input, CENSUS\_ID); System.debug('isSuccess: ' + result.isSuccess); for (ConnectApi.MemberWithPlansRepresentation member : result.members) { System.debug('memberId: ' + member.memberId + ', memberPlans: ' + member.memberPlans + ', errors: ' + member.errors); } } catch (Exception e) { System.debug('Error while adding members with plans: ' + e.getMessage()); } # Amount with Frequency Output representation of the amount details with frequency. ## JSON Example This example shows a sample success response. "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | annually | Double | Expected revenue amount that’s calculated annually. | Small, 63.0 | 63.0 | | monthly | Double | Expected revenue amount that’s calculated monthly. | Small, 63.0 | 63.0 | | quarterly | Double | Expected revenue amount that’s calculated quarterly. | Small, 63.0 | 63.0 | # Apex String Input representation for a key-value pair. ## JSON Example { "key": "FieldName\_\_c", "value": "FieldValue" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | key | String | API name of the field. | Optional | 65.0 | | value | String | Value to assign to the field. | Optional | 65.0 | # Apply Contract Adjustment to Member Policy Action Apply contract adjustment to group insurance policy for a primary group census member and a contract group plan. For each plan, the action enrolls a new policy, endorses an existing policy, or cancels a policy for a removed plan based on the endorsed contract version and the member's plan configuration. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/applyContractAdjToMemberPolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractGroupPlanId | string | Required. ID of the root contract group plan to retrieve the associated product and member plan configuration for the endorsed contract version. | | groupCensusMemberId | string | Required. ID of the primary group census member whose insurance policies must be processed because of contract mid-term adjustment. | | pricingResult | Apex-defined | Optional. An Apex ind\_ins\_grpben\_\_MembersPlansRatingOutput record that contains the pricing result for the member's plans. Used when creating a new policy version as part of a contract mid-term adjustment during enrollment and endorsement operations if shouldReprice is set to True . | ## Outputs | Output | Type | Description | | --- | --- | --- | | insurancePolicyIds | string | List of IDs for the insurance policies that are issued, endorsed, or canceled. | ## Example **POST** This sample request is for the Apply Contract Adjustments to Member Policy action when a group insurance policy is enrolled or endorsed for a primary group census member. { "inputs": \[ { "groupCensusMemberId": "a1Hxx0000001AAA", "contractGroupPlanId": "0YQ000000000001AAA", "pricingResult": { "pricingResults": \[ { "memberId": "a1Hxx0000001AAA", "plans": \[ { "planId": "0YQ000000000001AAA", "rates": \[ { "key": "NetUnitPrice", "value": 150 } \], "proratedRates": \[ { "key": "NetUnitPrice", "value": 125 } \], "contributions": { "employeePremiumAmount": 50, "employerPremiumAmount": 100 } } \] } \], "errors": \[\] } } \] } This sample request is for the Apply Contract Adjustments to Member Policy action when a group insurance policy is canceled for a primary group census member. { "inputs": \[ { "groupCensusMemberId": "a1Hxx0000001AAA", "contractGroupPlanId": "0YQ000000000001AAA" } \] } This is a successful sample response is for the Apply Contract Adjustments to Member Policy action. \[ { "actionName": "applyContractAdjToMemberPolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insurancePolicyIds": \["1RPv00000000010AAA", "1RPv00000000011AAA"\] }, "sortOrder": -1, "version": 1 } \] This is a sample response with errors for the Apply Contract Adjustments to Member Policy action. \[ { "actionName": "applyContractAdjToMemberPolicy", "errors": \[ { "statusCode": "INVALID\_INPUT", "message": "The groupCensusMemberId parameter is required.", "fields": \[\] } \], "invocationId": null, "isSuccess": false, "outcome": null, "outputValues": { "insurancePolicyIds": null }, "sortOrder": -1, "version": 1 } \] # Apply Member Overrides Action Apply member-specific overrides that differ from the member’s group class default configuration on a group insurance quote. Use this action to apply plan, coverage, or attribute overrides, or to clone an override configuration from one group census member to one or more target group census members on the same root plan. Cloning replaces each target member’s existing override configuration. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/applyMemberOverrides Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contextId | string | Transaction context ID. If specified, it takes precedence over the inline overrides input. | | memberOverrides | Apex-defined | An Apex ConnectApi.MemberOverridesContainerInputRepresentation record containing the per-member override action to apply. | | rootQliId | string | Required. ID of the root plan quote line item to which the member overrides are applied. | | sourceMemberId | string | ID of the group census member whose override configuration is copied to the target members. If specified, the action clones the source member's overrides onto the target members instead of applying the inline overrides. | | targetMemberIds | string | IDs of the group census members to receive the copied override configuration from the source member. Required if sourceMemberId is specified. | ## Outputs | Output | Type | Description | | --- | --- | --- | | resultMessage | string | Message describing the result of the operation. | ## Example **POST** This sample request is for the Apply Member Overrides action. { "input": \[ { "contextId": "1cuxx0000004C92EAA", "rootQliId": "0QLxx0000004CtoCAE", "memberOverrides": \[ { "contextId": "1cuxx0000004C92EAA", "rootQliId": "0QLxx0000004CtoCAE", "overrides": { "memberId": "0r6xx000000001aEAA", "overrideAction": "UPSERT", "productId": "01txx0000004C92AAE", "quoteLineItemId": "0QLxx0000004CtoCAE", "attributes": \[ { "attributeId": "a0Axx0000004C92EAA", "attributeValue": "1500" } \] } } \], "sourceMemberId": "0r6xx000000003cEAA", "targetMemberIds": \[ "0r6xx000000002bEAA" \] } \] } This sample response is for the Apply Member Overrides action. \[ { "actionName": "applyMemberOverrides", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "resultMessage": "The operation succeeded successfully." }, "sortOrder": -1, "version": 1 } \] # Attribute Detail Output representation of product attribute details. ## JSON Example This request shows a sample success response. "attributes": \[ { "id": "0tjSG0000001embYAA", "sequence": 1, #optional "name": "Copay", "label": "Copay Currency", #optional "dataType": "CURRENCY", "keyHidden":false, "isActive": true }, { "id": "0tjSG0000001eoDYAQ", "sequence": 1, "name": "Coinsurance", "label": "Coinsurance Percentage", "dataType": "PERCENTAGE", "keyHidden":false, "isActive": true } \] | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributeDefinitionId | String | ID of the attribute definition. | Small, 63.0 | 63.0 | | attributePicklistValueId | String | ID of the attribute picklist value. | Small, 63.0 | 63.0 | | dataType | String | Data type of attribute, such as Percentage. | Small, 63.0 | 63.0 | | id | String | ID of the product. | Small, 63.0 | 63.0 | | isActive | Boolean | Indicates whether the attribute is active (true) or not (false). | Small, 63.0 | 63.0 | | keyHidden | Boolean | Indicates whether the attribute key is hidden (true) or (not). | Small, 63.0 | 63.0 | | label | String | Label of the attribute. | Small, 63.0 | 63.0 | | name | String | Name of the attribute. | Small, 63.0 | 63.0 | | picklistValues | [Attribute Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_attribute_picklist_value.htm "Output representation of the picklist value details.")\[\] | List of picklist values. | Small, 63.0 | 63.0 | | sequence | Integer | Sequence of attribute. | Small, 63.0 | 63.0 | | value | String | Value of attribute. | Small, 63.0 | 63.0 | # Attribute Input Input representation of an overridden attribute value on a group census member plan. ## JSON Example { "attributes": { "values": \[ { "attributeCode": "Deductible", "attributeValue": "0" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeCode | String | Product attribute code that identifies the attribute to override with a new value. | Required if you want to add attributes to a standard or off-contract coverage | 68.0 | | attributeValue | String | Attribute value to be applied to the attribute code. | Required if attributeCode is specified | 68.0 | # Attribute Picklist Value Output representation of the picklist value details. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributePicklistId | String | ID of the attribute picklist. | Small, 63.0 | 63.0 | | id | String | ID of the product. | Small, 63.0 | 63.0 | | name | String | Name of the attribute. | Small, 63.0 | 63.0 | | value | String | Value of the attribute. | Small, 63.0 | 63.0 | # Benefits Output representation details of the plan benefits for an insurance policy coverage plan. ## JSON Example { "benefits": \[ { "benefitId": "bft1", "benefitSequence": 1, "productId": "01tSG0000011yBFxxY", "productName": "Preventive Care", "productCompGrpId": "0y7SG0000000Q8zxxE", "productCompGgpName": "General plan information", "productCompGgpSequence": 1, "network": "First Network Tier", "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 400, "sequence": 1, "keyHidden": false, "dataType": "Currency" }, { "attributeDefinitionId": "0tjSG00000020yPxxQ", "name": "Deductible waiver", "value": "Deductible waived", "sequence": 2, "keyHidden": true, "dataType": "Text" }, { "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Notes", "value": "In network limitations apply.", "sequence": 2, "keyHidden": true, "dataType": "Text" } \] } \] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | benefitId | String | ID of the Insurance Policy Coverage Benefit. | 63.0 | | benefitSequence | String | Field sequence of the Insurance Policy Coverage Benefit. | 63.0 | | network | String | Type of tier of the network. | 63.0 | | productId | String | ID of the product. | 63.0 | | productCompGgpId | String | ID of product component group. | 63.0 | | productCompGgpName | String | Name of product component group. | 63.0 | | productCompGgpSequence | String | Field sequence of the product component group. | 63.0 | | productName | String | Name of the product. | 63.0 | | attributes | [Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_benefits_attributes_output.htm "Output representation details of the benefits attributes for an insurance policy coverage plan.") | List of attributes of the plan benefits. | 63.0 | # Build a Self-service Quote and Policy Creation Functionality for Community Portal Users This user journey applies when a user, such as a policyholder or partner, logs into a customer community portal to select a product, view its price, and configure its attributes. The user then creates a quote, and proceeds to issue a policy. **Assumption** It’s assumed that the user logs into the community portal, selects a product to generate a quote, and then gets the policy issued. Use these steps to build the user journey. 1. **Generate Priced Context**—Make a POST request on the [Insurance Product Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm "HTML (New Window)") Connect API with the required inputs to generate the price adjusted context. This request returns the context ID in the response. 2. **Create Quote**—Use the context ID to create a quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. This request returns a quote ID in the response. 3. **Get Quote Context**—Use the quote ID to retrieve the quote details either by: - Making a GET request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_quote_details.htm "HTML (New Window)") invocable action. This request returns the context ID in the response that contains the context of the quote. 4. **Issue Policy**—Use the retrieved quote context to create a policy record either by: - Making a POST request on the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_policy.htm "HTML (New Window)") Connect API, or - Using the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_insurance_policy.htm "HTML (New Window)") invocable action. # Bulk Cancel Policy (POST) Cancel policies in bulk for the specified insurance policy IDs. ## Resource /connect/insurance/brokerage/policies/bulk-cancel ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-cancel ## Available Version 64.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "insurancePolicyIds": \["0IFxx0000004C1PGAU", "0IFxx0000004C1QGAU"\], "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 64.0 | | insurancePolicyIds | Object | List of insurance policy IDs to perform bulk operations. | Required | 64.0 | ## Response Body for POST [Insurance Policy Bulk](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # Bulk Endorse Draft Policy (POST) Create endorsement drafts in bulk for the specified insurance policies. You can modify the drafts until you endorse the policies using the Bulk Endorse Policy API. After you endorse the policies, you can't make any further changes. ## Resource /connect/insurance/brokerage/policies/bulk-endorse-draft ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-endorse-draft ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "policies": \[ { "policyId": "0YTxx00000000mPGAQ", "fieldValueMap": { "reinstatementDate": "2026-01-15" } } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policies | Object | List of insurance policies with their field value maps. | Required | 67.0 | ## Response Body for POST [Insurance Policy Bulk Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # Bulk Endorse Policy (POST) Endorse policies in bulk for the specified insurance policy IDs. ## Resource /connect/insurance/brokerage/policies/bulk-endorse ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-endorse ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "insurancePolicyIds": \["0IFxx0000004C1PGAU", "0IFxx0000004C1QGAU"\], "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 64.0 | | insurancePolicyIds | Object | List of insurance policy IDs to perform bulk operations. | Required | 64.0 | ## Response Body for POST [Insurance Policy Bulk Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # Bulk Group Census Management Output representation for the bulk processing of employee census data. ## JSON Example { "errors": \[\], "isSuccess": true, "requestId": "a1Bxx000000001aEAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [ConnectApi.ErrorResponse](https://developer.salesforce.com/docs/atlas.en-us.258.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm) | List of errors that contains a message and an error code. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the request is successful (true) or not (false). | Small, 65.0 | 65.0 | | requestId | String | ID of the asynchronous job request. | Small, 65.0 | 65.0 | # Bulk Group Census Management Input Input representation to bulk-process group census data from a CSV file. ## JSON Example { "batchSize": 200, "contentDocumentId": "069SG000003gLazYAE", "contentDocumentVersionId": "0688d0000025fA3AAI", "duplicateDetectionFields": { "values": \[ "FirstName", "Lastname" \] }, "csvColumnMapping": { "data": { "First Name": "FirstName", "Last Name": "Lastname", "Email": "Email", "Birthdate": "Birthdate", "Gender": "Gender", "Relationship to Primary Member": "AssociationWithPrimaryMbr", "Medical": "ContractGroupPlan", "Dental": "ContractGroupPlan", "Group Class": "GroupClassName" } }, "shouldExecuteConfigurationRule": false } ## Properties
Name Type Description Required or Optional Available Version
batchSize Integer Number of CSV records to process in each batch.

The default size for Quote Census is 2000.

The default size for Enrollment Census is 25.

 Optional 65.0
content​DocumentId String ID of the content document (CSV file) to process. Required 65.0
contentDocument​VersionId String ID of the specific version of the content document. Optional 65.0
csvColumnMapping Map<String, String> Map where the key is the CSV column header and the value is the API name of the corresponding field in the GroupCensusMember object. Required 65.0
duplicate​Detection​Fields String[] List of field API names that are used to generate a unique key for identifying duplicate members along with the default values.

The default fields that are used to detect duplication are FirstName, LastName, groupCensusId, and AssociationWithPrimaryMbr.

Optional 65.0
shouldExecute​Configuration​Rule Boolean Indicates whether to execute the configuration rules after processing the data (true) or not (false).

The default value is false.

Optional 65.0
# Bulk Issue Policy (POST) Issue policies in bulk for the specified insurance policy IDs. ## Resource /connect/insurance/brokerage/policies/bulk-issue ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-issue ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "insurancePolicyIds": \["0IFxx0000004C1PGAU", "0IFxx0000004C1QGAU"\], "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 64.0 | | insurancePolicyIds | Object | List of insurance policy IDs to perform bulk operations. | Required | 64.0 | ## Response Body for POST [Insurance Policy Bulk Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # Bulk Pay Claim Coverage Payment Details (POST) Initiate asynchronous payment processing for claim coverage payment detail records in bulk. Specify the claim coverage payment detail IDs you want to process for payment, and the API validates access, enqueues work, and returns an identifier you can use to track the bulk job. ## Resource /connect/insurance/claims/coverages/payment-details/bulk-pay ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/coverages/payment-details/bulk-pay ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "recordIds": { "list": \[ "0l2kSG0000000WXl0AM", "0l2SG0000000WX20AM" \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordIds | List of String | Identifiers of the claim coverage payment detail records for which you want to run payment processing. | Required | 67.0 | ## Response Body for POST [Bulk Pay Claim Coverage Payment Details Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_bulk_pay_claim_coverage_payment_detail.htm "Output representation of the details of the bulk pay CCPD API call. The API returns a system-generated request ID for tracking asynchronous processing, and any errors reported for the operation.") # Bulk Pay Claim Coverage Payment Details Action Process payments for Claim Coverage Payment Detail (CCPD) records in bulk. This action is available in API version 67.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/payClaimCvrPymtDetailsInBulk Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | bulkPayClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex ConnectApi\_\_bulkPayClaimCvrPymtDtlInputRep record that contains the IDs of the claim coverage payment detail records to process the payments for. | ## Outputs | Output | Type | Description | | --- | --- | --- | | bulkPayClaimCvrPymtDtlRep | Apex-defined | An Apex ConnectApi\_\_bulkPayClaimCvrPymtDtlRep record that contains the details of the asynchronous bulk payment processing job. | ## Example **POST** This sample request is for the Bulk Pay Claim Coverage Payment Details action. { "inputs": \[ { "bulkPayClaimCvrPymtDtlInputRep": { "recordIds": { "list": \[ "0l2kSG0000000WXl0AM", "0l2SG0000000WX20AM" \] } } } \] } This sample response is for the Bulk Pay Claim Coverage Payment Details action. { "actionName": "payClaimCvrPymtDetailsInBulk", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "requestId": "0X0djiwoed" }, "sortOrder": -1, "version": 1 } # Bulk Pay Claim Coverage Payment Details Input Input representation of the details for the bulk pay CCPD resource. ## JSON Example { "recordIds": { "list": \[ "0l2kSG0000000WXl0AM", "0l2SG0000000WX20AM" \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordIds | List of String | Identifiers of the claim coverage payment detail records for which you want to run payment processing. | Required | 67.0 | # Bulk Pay Claim Coverage Payment Details Response Output representation of the details of the bulk pay CCPD API call. The API returns a system-generated request ID for tracking asynchronous processing, and any errors reported for the operation. ## JSON Example { "requestId": "0X0djiwoed", "isSuccess": true, "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Errors that are returned when the bulk pay operation fails or when individual records cannot be processed. Empty when there are no errors to report. | Big, 67.0 | 67.0 | | isSuccess | Boolean | Indicates whether the API operation completed successfully (true) or not (false). | Big, 67.0 | 67.0 | | requestId | String | System-generated ID that identifies the asynchronous bulk payment processing work to track the job status. | Big, 67.0 | 67.0 | # Bulk Product Clause Input Input representation for creating one or a list of product clauses. ## JSON Example { "productClauses": \[ { "apiName": "AutoGlassClause\_2025", "name": "Auto Glass Clause", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31", "insuranceClauseId": "0j1xx0000000001AAA", "rootProduct": "01t000000003CCC", "productPath": "01t000000003DDD", "variableMappings": \[ { "variable": "DeductibleAmount", "variableType": "Currency", "attribute": "WaiverAmount" }\] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauses | [Product Clause Input\[\]](connect_requests_insurance_create_product_clause_input.htm "Input representation for the details of a single product clause to be created.") | Details to create product clauses. | Required | 65.0 | # Bulk Reinstate Policy (POST) Reinstate policies in bulk for the specified insurance policy IDs. ## Resource /connect/insurance/brokerage/policies/bulk-reinstate ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-reinstate ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "policies": \[ { "policyId": "0YTxx00000000mPGAQ", "fieldValueMap": { "reinstatementDate": "2026-01-15" } } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policies | Object | List of insurance policies with their field value maps. | Required | 67.0 | ## Response Body for POST [Insurance Policy Bulk Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # Bulk Renew Policy (POST) Renew policies in bulk for the specified insurance policy IDs. ## Resource /connect/insurance/brokerage/policies/bulk-renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/bulk-renew ## Available Version 64.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "insurancePolicyIds": \["0IFxx0000004C1PGAU", "0IFxx0000004C1QGAU"\], "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 64.0 | | insurancePolicyIds | Object | List of insurance policy IDs to perform bulk operations. | Required | 64.0 | ## Response Body for POST [Insurance Policy Bulk](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm "Output representation for bulk policy lifecycle operations.") # bulkCancelInsurancePolicy(insurancePolicyBulkInput) Cancel policies in bulk for the specified Insurance Policy IDs. ## API Version 64.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkCancelInsurancePolicy(ConnectApi.InsurancePolicyBulkInputRepresentation insurancePolicyBulkInput) ## Parameters **insurancePolicyBulkInput** - Type: [ConnectApi.InsurancePolicyBulkInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk.htm "Input representation details to manage policies in bulk.") - Input representation of the request to cancel policies in bulk. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Use this method to cancel insurance policies in bulk. The JSON input includes a field value map of insurance policy fields, such as CancellationEffectiveDate, Status, and CancellationReason, and a list of insurance policy IDs. After the request is successfully sent to the message queue, policies are canceled asynchronously, and you receive either a success or failure notification after the completion of the request. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkCancelInsurancePolicy() method to cancel multiple insurance policies in bulk. **Class Definition** This Apex example shows how to cancel multiple policies in bulk. global class BulkCancelConnectDriver { global static void callBulkCancelConnectAPI() { Map input = new Map(); ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkInputRepresentation(); List policyIds = new List{ '0YTxx000000001dGAA', '0YTxx000000002dGAA', '0YTxx000000003dGAA' }; bulkInput.insurancePolicyIds = policyIds; Map fields = new Map(); fields.put('CancellationReason', 'Batch Cancellation'); fields.put('CancellationEffectiveDate', '2026-07-01'); bulkInput.fieldValueMap = fields; input.put('bulkInput', bulkInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); BulkCancelTestConnectAPI callable = new BulkCancelTestConnectAPI(); Object result = callable.call('bulkCancel', args); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData = (ConnectApi.InsurancePolicyBulkOutputRepresentation) result; System.debug('Bulk Cancel Data: ' + JSON.serializePretty(bulkData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the BulkCancelTestConnectAPI class to execute the bulkCancel action and process the result. public class BulkCancelTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'bulkCancel') { ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = (ConnectApi.InsurancePolicyBulkInputRepresentation) inputMap.get('bulkInput'); System.debug('Start of Connect API call to bulk cancel policies'); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData; try { bulkData = ConnectApi.InsuranceBrokerageFamily.bulkCancelInsurancePolicy(bulkInput); System.debug('Policies bulk cancelled successfully: ' + bulkData); outputMap.put('bulkData', bulkData); } catch (Exception e) { System.debug('Error while bulk cancelling policies: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return bulkData; } return null; } } // Execute BulkCancelConnectDriver.callBulkCancelConnectAPI(); # bulkEndorseDraftInsurancePolicy(insurancePolicyBulkFieldMapInput) Endorse draft policies in bulk for the specified insurance policy IDs. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkEndorseDraftInsurancePolicy(ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation insurancePolicyBulkFieldMapInput) ## Parameters **insurancePolicyBulkFieldMapInput** - Type: [ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk_field_map.htm "Input representation for Insurance Policy Bulk Lifecycle process APIs with per-policy field value maps.") - Input representation of the request to endorse draft policies in bulk. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Use this method to create endorsement drafts for insurance policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs. After the request is successfully sent to the message queue, endorsement drafts are created asynchronously, and you receive either a success or failure notification after the completion of the request. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkEndorseDraftInsurancePolicy() method to create endorsement drafts for multiple insurance policies in bulk. **Class Definition** This Apex example shows how to create endorsement drafts for multiple policies in bulk. global class BulkDraftEndorseConnectDriver { global static void callBulkDraftEndorseConnectAPI() { Map input = new Map(); ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation(); // Each policy now carries its own field value map instead of one shared map. List> policies = new List>(); policies.add(buildPolicy('0YTxx000000001dGAA', new Map{ 'Name' => 'Bulk Draft Endorse 1' })); policies.add(buildPolicy('0YTxx000000002dGAA', new Map{ 'Name' => 'Bulk Draft Endorse 2' })); policies.add(buildPolicy('0YTxx000000003dGAA', new Map{ 'Name' => 'Bulk Draft Endorse 3' })); bulkInput.policies = policies; input.put('bulkInput', bulkInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); BulkDraftEndorseTestConnectAPI callable = new BulkDraftEndorseTestConnectAPI(); Object result = callable.call('bulkDraftEndorse', args); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData = (ConnectApi.InsurancePolicyBulkOutputRepresentation) result; System.debug('Bulk Draft Endorse Data: ' + JSON.serializePretty(bulkData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } // Builds a single { policyId, fieldValueMap } entry for the policies list. private static Map buildPolicy(String policyId, Map fieldValueMap) { Map policy = new Map(); policy.put('policyId', policyId); policy.put('fieldValueMap', fieldValueMap); return policy; } } **Usage Example** Use the BulkDraftEndorseTestConnectAPI class to execute the bulkDraftEndorse action and process the result. public class BulkDraftEndorseTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'bulkDraftEndorse') { ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation bulkInput = (ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation) inputMap.get('bulkInput'); System.debug('Start of Connect API call to bulk draft endorse policies'); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData; try { bulkData = ConnectApi.InsuranceBrokerageFamily.bulkEndorseDraftInsurancePolicy(bulkInput); System.debug('Policies bulk draft endorsed successfully: ' + bulkData); outputMap.put('bulkData', bulkData); } catch (Exception e) { System.debug('Error while bulk draft endorsing policies: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return bulkData; } return null; } } // Execute BulkDraftEndorseConnectDriver.callBulkDraftEndorseConnectAPI(); # bulkEndorseInsurancePolicy(insurancePolicyBulkInput) Endorse policies in bulk for the specified insurance policy IDs. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkEndorseInsurancePolicy(ConnectApi.InsurancePolicyBulkInputRepresentation insurancePolicyBulkInput) ## Parameters **insurancePolicyBulkInput** - Type: [ConnectApi.InsurancePolicyBulkInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk.htm "Input representation details to manage policies in bulk.") - Input representation of the request to endorse policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs to endorse. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Use this method to endorse insurance policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs. After the request is successfully sent to the message queue, policies are endorsed asynchronously, and you receive either a success or failure notification after the completion of the request. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkEndorseInsurancePolicy() method to endorse multiple insurance policies in bulk. **Class Definition** This Apex example shows how to endorse multiple policies in bulk. global class BulkEndorseConnectDriver { global static void callBulkEndorseConnectAPI() { Map input = new Map(); ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkInputRepresentation(); List policyIds = new List{ '0YTxx000000001dGAA', '0YTxx000000002dGAA', '0YTxx000000003dGAA' }; bulkInput.insurancePolicyIds = policyIds; input.put('bulkInput', bulkInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); BulkEndorseTestConnectAPI callable = new BulkEndorseTestConnectAPI(); Object result = callable.call('bulkEndorse', args); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData = (ConnectApi.InsurancePolicyBulkOutputRepresentation) result; System.debug('Bulk Endorse Data: ' + JSON.serializePretty(bulkData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the BulkEndorseTestConnectAPI class to execute the bulkEndorse action and process the result. public class BulkEndorseTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'bulkEndorse') { ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = (ConnectApi.InsurancePolicyBulkInputRepresentation) inputMap.get('bulkInput'); System.debug('Start of Connect API call to bulk endorse policies'); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData; try { bulkData = ConnectApi.InsuranceBrokerageFamily.bulkEndorseInsurancePolicy(bulkInput); System.debug('Policies bulk endorsed successfully: ' + bulkData); outputMap.put('bulkData', bulkData); } catch (Exception e) { System.debug('Error while bulk endorsing policies: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return bulkData; } return null; } } // Execute BulkEndorseConnectDriver.callBulkEndorseConnectAPI(); # bulkIssueInsurancePolicy(insurancePolicyBulkInput) Issue policies in bulk for the specified insurance policy IDs. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkIssueInsurancePolicy(ConnectApi.InsurancePolicyBulkInputRepresentation insurancePolicyBulkInput) ## Parameters **insurancePolicyBulkInput** - Type: [ConnectApi.InsurancePolicyBulkInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk.htm "Input representation details to manage policies in bulk.") - Input representation of the request to issue policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs to issue. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Use this method to issue insurance policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs. After the request is successfully sent to the message queue, policies are issued asynchronously, and you receive either a success or failure notification after the completion of the request. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkIssueInsurancePolicy() method to issue multiple insurance policies in bulk. **Class Definition** This Apex example shows how to issue multiple policies in bulk. global class BulkIssueConnectDriver { global static void callBulkIssueConnectAPI() { Map input = new Map(); ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkInputRepresentation(); List policyIds = new List{ '0YTxx000000001dGAA', '0YTxx000000002dGAA', '0YTxx000000003dGAA' }; bulkInput.insurancePolicyIds = policyIds; input.put('bulkInput', bulkInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); BulkIssueTestConnectAPI callable = new BulkIssueTestConnectAPI(); Object result = callable.call('bulkIssue', args); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData = (ConnectApi.InsurancePolicyBulkOutputRepresentation) result; System.debug('Bulk Issue Data: ' + JSON.serializePretty(bulkData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the BulkIssueTestConnectAPI class to execute the bulkIssue action and process the result. public class BulkIssueTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'bulkIssue') { ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = (ConnectApi.InsurancePolicyBulkInputRepresentation) inputMap.get('bulkInput'); System.debug('Start of Connect API call to bulk issue policies'); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData; try { bulkData = ConnectApi.InsuranceBrokerageFamily.bulkIssueInsurancePolicy(bulkInput); System.debug('Policies bulk issued successfully: ' + bulkData); outputMap.put('bulkData', bulkData); } catch (Exception e) { System.debug('Error while bulk issuing policies: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return bulkData; } return null; } } // Execute BulkIssueConnectDriver.callBulkIssueConnectAPI(); # bulkReinstateInsurancePolicy(insurancePolicyBulkFieldMapInput) Reinstate policies in bulk for the specified insurance policy IDs. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkReinstateInsurancePolicy(ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation insurancePolicyBulkFieldMapInput) ## Parameters **insurancePolicyBulkFieldMapInput** - Type: [ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk_field_map.htm "Input representation for Insurance Policy Bulk Lifecycle process APIs with per-policy field value maps.") - Input representation of the request to reinstate policies in bulk. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Use this method to reinstate previously canceled insurance policies in bulk. The JSON input includes a field value map of insurance policy fields and a list of insurance policy IDs. After the request is successfully sent to the message queue, policies are reinstated asynchronously, and you receive either a success or failure notification after the completion of the request. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkReinstateInsurancePolicy() method to reinstate multiple insurance policies in bulk. **Class Definition** This Apex example shows how to reinstate multiple policies in bulk. public class BulkReinstateConnectDriver { public static void callBulkReinstateConnectAPI() { List policies = new List{ newPolicy('0YTxx00000000mPGAQ', new Map{ 'reinstatementDate' => '2026-01-15' }) // add more entries here, each with its own fieldValueMap }; HttpResponse res = post('/connect/insurance/brokerage/policies/bulk-reinstate', policies); System.debug('Status: ' + res.getStatusCode() + ' ' + res.getStatus()); System.debug('Body: ' + res.getBody()); } private static Map newPolicy(String policyId, Map fieldValueMap) { return new Map{ 'policyId' => policyId, 'fieldValueMap' => fieldValueMap }; } private static HttpResponse post(String resourcePath, List policies) { HttpRequest req = new HttpRequest(); req.setEndpoint(URL.getOrgDomainUrl().toExternalForm() + '/services/data/v68.0' + resourcePath); req.setMethod('POST'); req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId()); req.setHeader('Content-Type', 'application/json'); req.setBody(JSON.serialize(new Map{ 'policies' => policies })); return new Http().send(req); } } // Execute BulkReinstateConnectDriver.callBulkReinstateConnectAPI(); # bulkRenewInsurancePolicy(insurancePolicyBulkInput) Renew policies in bulk for the specified Insurance Policy IDs. ## API Version 64.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkRenewInsurancePolicy(ConnectApi.InsurancePolicyBulkRenewInputRepresentation insurancePolicyBulkInput) ## Parameters **insurancePolicyBulkInput** - Type: [ConnectApi.InsurancePolicyBulkRenewInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk_renew.htm "Input representation details of the renew insurance policies in bulk resource. The input includes the list of insurance policy IDs to be renewed and the details of the associated fields of the insurance policies.") - Input representation of the request to renew insurance policies in bulk. ## Return Value Type: [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.") ## Usage Insurance Policy Bulk Renewal API takes a JSON input that contains a list of insurance policy IDs that must be renewed along with the fieldValueMap details. The API submits the request to a queue, creates policies, along with child records by using the context definition selected in setup. The service also overrides the fieldValueMap in the new policy for each policy ID passed in the request. Users receive success and failure notifications on completion. Keep these considerations in mind when you use this method. - The RenewedFromPolicyId value of the new policy is set to the current policy ID and IsRenewedPolicy field of the new policy is set to true. - The name of the new policy is a copy of {ExistingName}. - The fieldValueMap expects the keys to be API name and is case-sensitive. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkRenewInsurancePolicy() method to renew multiple insurance policies in bulk. **Class Definition** This Apex example shows how to renew multiple policies in bulk. global class BulkRenewConnectDriver { global static void callBulkRenewConnectAPI() { Map input = new Map(); ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkInputRepresentation(); List policyIds = new List{ '0YTxx000000001dGAA', '0YTxx000000002dGAA', '0YTxx000000003dGAA' }; bulkInput.insurancePolicyIds = policyIds; Map fields = new Map(); fields.put('Name', 'Bulk Renewed Policy'); bulkInput.fieldValueMap = fields; input.put('bulkInput', bulkInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); BulkRenewTestConnectAPI callable = new BulkRenewTestConnectAPI(); Object result = callable.call('bulkRenew', args); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData = (ConnectApi.InsurancePolicyBulkOutputRepresentation) result; System.debug('Bulk Renew Data: ' + JSON.serializePretty(bulkData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the BulkRenewTestConnectAPI class to execute the bulkRenew action and process the result. public class BulkRenewTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'bulkRenew') { ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = (ConnectApi.InsurancePolicyBulkInputRepresentation) inputMap.get('bulkInput'); System.debug('Start of Connect API call to bulk renew policies'); ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData; try { bulkData = ConnectApi.InsuranceBrokerageFamily.bulkRenewInsurancePolicy(bulkInput); System.debug('Policies bulk renewed successfully: ' + bulkData); outputMap.put('bulkData', bulkData); } catch (Exception e) { System.debug('Error while bulk renewing policies: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return bulkData; } return null; } } // Execute BulkRenewConnectDriver.callBulkRenewConnectAPI(); # Calculate Adjustments Output representation of the details for calculating the adjustments for the claim loss item. ## JSON Example { "isSuccess": true, "adjustedAmount": 1250.00, "adjustmentReason": "Deductible applied.", "claimCovPaymentAdjustments": \[ { "adjustedAmount": 250.00, "adjustmentReason": "Deductible" } \], "insPolicyLimitTrackings": \[ { "policyLimitId": "0lYx00000004CvQEAU", "category": "Per-Incident Limit", "remainingAmount": 4750.00 } \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | adjustedAmount | Double | Amount after adjustments are made based on the current standings of the policy limits. | Big, 65.0 | 65.0 | | adjustmentReason | String | Reason for the claim coverage payment detail adjustment such as deductible, copay, or coinsurance. | Big, 65.0 | 65.0 | | claimCov​Payment​Adjustments | [Claim Coverage Payment Adjustment Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_cov_payment_adj_details.htm "Output representation for the claim coverage payment adjustment details.")\[\] | List of claim coverage payment adjustment details. | Big, 65.0 | 65.0 | | errors | [Error Detail \[\]](connect_responses_error_details.htm "Output representation of the error details.") | List of errors that are associated with the API request. | Big, 65.0 | 65.0 | | insPolicy​LimitTrackings | [Insurance Policy Limit Tracking Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_limit_tracking_details.htm "Output representation for the insurance policy limit tracking details.")\[\] | List of insurance policy limit tracking details. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # Calculate Adjustments Action Calculate the adjusted amount for a loss item and generate data for insurance policy limit tracking and claim coverage payment adjustment records. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/calculateAdjustments Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | calculateAdjustmentsInputRep | Apex-defined | Required. An Apex ConnectApi.CalculateAdjustmentsInputRep record that contains the details of the claim to calculate the adjusted amount for a loss item. | ## Outputs | Output | Type | Description | | --- | --- | --- | | calculateAdjustmentsOutputRep | Apex-defined | An Apex [ConnectApi.CalculateAdjustmentsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_calculate_adjustments.htm "Output representation of the details for calculating the adjustments for the claim loss item.") record that contains the details of the adjustments for the claim loss items. | ## Example Sample Request { "inputs": \[ { "calculateAdjustmentsInputRep": { "claimId": "0ZkSB0000000tqv0AA", "claimCoverageId": "0kPSB000000G72L2AS", "claimedAmount": "1000", "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false } } } \] } Sample Response { "actionName": "calculateAdjustments", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "calculateAdjustmentsOutputRep": { "adjustedAmount": 1250.00, "adjustmentReason": "Deductible applied." "claimCovPaymentAdjustments": \[ { "adjustedAmount": 250.00, "adjustmentReason": "Deductible" } \], "insPolicyLimitTrackings": \[ { "policyLimitId": "0lYx00000004CvQEAU", "category": "Per-Incident Limit", "remainingAmount": 4750.00 } \] } }, "sortOrder": -1, "version": 1 } # Calculate Adjustments Input Input representation for calculating adjustments for the claim loss item. ## JSON Example { "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Network\_Type\_\_c": "Car Rental Network", "Claimant\_Phone\_\_c": "123456789", "Claimant\_Email\_\_c": "test@email.com", "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false }, "benefitName": "Car Rental", "claimedAmount": 1500 } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to calculate the adjusted amount for a loss item. | Optional | 67.0 | | benefitName | String | Name of the specific benefit or sub-coverage that's associated with the coverage, as defined in the product attribute mapping. | Optional | 66.0 | | claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Required | 65.0 | # Calculate or Recalculate Adjustments (POST, PATCH) Calculate adjustments for a new loss item (POST) or recalculate adjustments for an existing payment detail record (PATCH) under a claim coverage. This API uses the default Expression Set Executable Template to perform the calculation and applies the standard policy rules, such as deductibles, co-pays, co-insurance, and limits to an initial claimed amount. You can either extend the executable template to create a custom Expression Set or create an Integration Procedure to include custom calculations. The API uses the claimedAmount, claimId, and claimCoverageId as input, and returns the final adjustedAmount along with the generated data for Claim Coverage Payment Adjustments (CCPAs) and Insurance Policy Limit Tracking (IPLT) records. This API only returns the data; it doesn't save them in database. ## Resource {claimId} and {coverageId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/calculate-adjustments ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/calculate-adjustments ## Available Version 65.0PATCH is available in version 66.0 and later. ## HTTP Methods POST, PATCH ## Path Parameter for POST and PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim for which the payment adjustments must be calculated. | Required | 65.0 | | coverageId | String | ID of the claim coverage record. | Required | 65.0 | ## Request Body for POST Calculate adjustments during the creation of a Loss item. ### JSON Example { "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Network\_Type\_\_c": "Car Rental Network", "Claimant\_Phone\_\_c": "123456789", "Claimant\_Email\_\_c": "test@email.com", "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false }, "benefitName": "Car Rental", "claimedAmount": 1500 } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to calculate the adjusted amount for a loss item. | Optional | 67.0 | | benefitName | String | Name of the specific benefit or sub-coverage that's associated with the coverage, as defined in the product attribute mapping. | Optional | 66.0 | | claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Required | 65.0 | ## Response Body for POST [Calculate Adjustments](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_calculate_adjustments.htm "Output representation of the details for calculating the adjustments for the claim loss item.") ## Request Body for PATCH Recalculate adjustments for an existing payment detail. ### JSON Example { "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Network\_Type\_\_c": "Car Rental Network", "Claimant\_Phone\_\_c": "123456789", "Claimant\_Email\_\_c": "test@email.com", "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false }, "claimedAmount": 1200, "paymentDetailId": "0l2xx0000000001CAA" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to recalculate the adjusted amount for an existing payment detail record. | Optional | 67.0 | | claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Optional | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail for recalculating adjustments. | Optional | 66.0 | ## Response Body for PATCH [Calculate Adjustments](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_calculate_adjustments.htm "Output representation of the details for calculating the adjustments for the claim loss item.") # Calculate Quote Price Without Creating a Formal Quote This user journey applies when a customer wants to see an estimated quote price based on their requirements without having to save a formal quote. Use the Quoting API if Quoting is managed within Salesforce. Use the Product Rating API when Quoting is not managed by Salesforce or when a third-party system handles the quoting process. 1. Calculate the quote price by using one of these methods. - **Quoting API**—Make a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API. Set the saveQuote parameter to false. - **Product Rating API**—Make a POST request on the [Insurance Product Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm "HTML (New Window)") Connect API to generate a price-adjusted context based on user inputs without creating a formal quote. # CalculateAdjustments(CalculateAdjustmentsInput, claimId, coverageId) Calculate adjustments for a loss item and determine the final payable amount for a specific claim loss item. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.CalculateAdjustmentsRepresentation CalculateAdjustments(ConnectApi.CalculateAdjustmentsInputRepresentation CalculateAdjustmentsInput, String claimId, String coverageId) ## Parameters **CalculateAdjustmentsInput** - Type: [ConnectApi.CalculateAdjustmentsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_calculate_adjustments.htm "Input representation for calculating adjustments for claim loss items.") - Details for calculating adjustments. **claimId** - Type: String - ID of the claim for which the adjustments must be calculated. **coverageId** - Type: String - ID of the claim coverage. ## Return Value Type: [ConnectApi.CalculateAdjustmentsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_calculate_adjustments.htm "Output representation of the details for calculating the adjustments for the claim loss item.") ## Example Here's an example of how to invoke the Calculate Adjustments API by using Apex. public with sharing class CalculateAdjustments implements System.Callable { public Object call(String action, Map args) { Map bodyMap = new Map(); // Extract 'input' and 'output' Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (inputMap != null) { if (inputMap.containsKey('claimId') && inputMap.get('claimId') != null) { bodyMap.put('claimId', String.valueOf(inputMap.get('claimId'))); } if (inputMap.containsKey('claimCoverageId') && inputMap.get('claimCoverageId') != null) { bodyMap.put('claimCoverageId', String.valueOf(inputMap.get('claimCoverageId'))); } if (inputMap.containsKey('claimedAmount') && inputMap.get('claimedAmount') != null) { bodyMap.put('claimedAmount', String.valueOf(inputMap.get('claimedAmount'))); } } else { System.debug('No input map found in args'); } String jsonBody = JSON.serialize(bodyMap); System.debug('Final JSON Body: ' + jsonBody); String str = postDataToExternalApi(bodyMap, jsonBody); return outputMap.put('API Response: ', str); } public static String postDataToExternalApi(Map bodyMap, String jsonBody) { HttpRequest request = new HttpRequest(); Http http = new Http(); String claimId = (String) bodyMap.get('claimId'); String claimCoverageId = (String) bodyMap.get('claimCoverageId'); String claimedAmount = (String) bodyMap.get('claimedAmount'); bodyMap.remove('claimId'); bodyMap.remove('claimCoverageId'); jsonBody = JSON.serialize(bodyMap); if (String.isBlank(claimId) || String.isBlank(claimCoverageId) || String.isBlank(claimedAmount)) { String errorMsg = 'Missing required fields - claimId: ' + claimId + ', claimCoverageId: ' + claimCoverageId + ', claimedAmount: ' + claimedAmount; System.debug('Validation failed: ' + errorMsg); return 'Error: ' + errorMsg; } // Build endpoint dynamically String endpoint = 'callout:invokeUW/services/data/v65.0/connect/insurance/claims/' + claimId + '/coverages/' + claimCoverageId + '/calculate-adjustments'; System.debug('>>> Dynamic Endpoint: ' + endpoint); request.setEndpoint(endpoint); request.setMethod('POST'); request.setHeader('Content-Type', 'application/json'); request.setTimeout(120000); // 2 mins request.setBody(jsonBody); try { HttpResponse response = http.send(request); System.debug('Status Code: ' + response.getStatusCode()); System.debug('Response Body: ' + response.getBody()); return response.getBody(); } catch (Exception e) { System.debug('Exception: ' + e.getMessage()); return 'Exception: ' + e.getMessage(); } } // Sample test method public static void testCalculateAdjustments() { Map args = new Map(); Map input = new Map(); Map output = new Map(); input.put('claimId', '0Zkxx000000009hCAA'); input.put('claimCoverageId', '0kPxx000000006TEAQ'); input.put('claimedAmount', '1200.0'); args.put('input', input); args.put('output', output); CalculateAdjustments test = new CalculateAdjustments(); test.call('calculateAdjustments', args); } } # Cancel Claim Coverage Payment Detail Output representation for the canceled claim coverage payment detail. ## JSON Example { "isSuccess": true, "paymentDetailId": "0l2xx000000003gEAA", "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail \[\]](connect_responses_error_details.htm "Output representation of the error details.") | Details of the errors that are associated with the API request. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 65.0 | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail for which the payment is canceled. | Big, 65.0 | 65.0 | # Cancel Claim Coverage Payment Detail (POST) Cancel payment for a claim coverage payment detail record. ## Resource {claimId}, {coverageId}, and {paymentDetailId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/cancel ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/cancel ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim whose coverage payment detail must be canceled. | Required | 65.0 | | coverageId | String | ID of the coverage that applies to the claim. | Required | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | Required | 65.0 | ## Response Body for POST [Cancel Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cancel_claim_coverage_payment_detail.htm "Output representation for the canceled claim coverage payment detail.") # Cancel Claim Coverage Payment Detail Action Cancel payment for a claim coverage payment detail record. When the coveragePaymentType is Loss, this action reverses the insurance policy limit tracking data to roll back consumption. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/cancelClaimCvrPaymentDetail Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | cancelClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex ConnectApi.CancelClaimCvrPymtDtlInputRep record that contains the details to cancel the payment for the claim coverage payment detail record. | ## Outputs | Output | Type | Description | | --- | --- | --- | | paymentDetailId | string | ID of the payment detail record for which the payment is canceled. | ## Example Sample Request { "inputs": \[ { "cancelClaimCvrPymtDtlInputRep": { "claimId": "0clS70000004p9XIAQ", "coverageId": "0kPxx000000002fEAA", "paymentDetailId": "0l2xx000000003gEAA" } } \] } Sample Response { "actionName": "cancelClaimCvrPaymentDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "paymentDetailId": "5pdS70000004oVfIAI" }, "sortOrder": -1, "version": 1 } # Cancel Insurance Brokerage Policy Action Cancel an insurance brokerage policy with optional cancellation details such as effective date, reason, and target status. This action is available in API version 67.0 and later. ## Special Access Rules The Cancel Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/cancelInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_CancelBrokeragePolicyIAInputRep record that contains the details to cancel an insurance policy. | ## Outputs | Output | Type | Description | | --- | --- | --- | | transactionId | string | Transaction ID that's generated during the policy cancellation operation. | ## Example **POST** This sample request is for the Cancel Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001", "cancellationEffectiveDate": "2026-07-01", "cancellationReason": "Customer requested cancellation", "status": "Cancelled" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for canceling a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('cancelInsBrokeragePolicy'); // Instantiate the input object ConnectApi.CancelBrokeragePolicyIAInputRep input = new ConnectApi.CancelBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the brokerage policy to be canceled input.policyId = '0YjXX0000000001'; // Optional: Set cancellation details input.cancellationEffectiveDate = '2026-07-01'; input.cancellationReason = 'Customer requested cancellation'; input.status = 'Cancelled'; // Set the invocation parameter and invoke action.setInvocationParameter('cancelBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Cancel Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Cancel Insurance Brokerage Policy action. \[ { "actionName": "cancelInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "transactionId": "txn\_abc123def456" }, "sortOrder": -1, "version": 1 } \] # Cancel Insurance Policy (POST) Cancel an insurance policy version. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/cancel ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx000000006TGAQ/cancel ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "effectiveDate": "2024-09-08", "transactionRecord":{ "name" : "Cancel Transaction" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the cancellation of the policy goes into effect. | Required | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | The JSON structure that overrides the transaction information. | Optional | 63.0 | ## Response Body for POST [Cancel Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cancel_policy_output.htm "Output representation of cancel policy details.") # Cancel Insurance Policy Action Cancel an insurance policy by using a set of user inputs that represent policy details. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/cancelInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Details
cancelPolicyIAInputRep Type

Apex-defined

Description

An Apex ConnectApi.CancelPolicyIAInputRep record that contains details of the policy to be canceled.
## Outputs
Output Details
cancelPolicyIAOutputRep Type

Apex-defined

Description

An Apex ConnectApi.CancelPolicyIAOutputRep record that contains the details of the policy that's canceled.
## Example Sample Request { "inputs": \[ { "CancelPolicyIAInputRep": { "policyId": "0YTxx00000001H3GAI", "effectiveDate": "2024-09-08", "transactionRecord":{ "name": "Cancel Transaction" } } } \] } Sample Response { "actionName": "cancelInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "CancelPolicyIAOutputRep": { "impactedPolicyVersions": \[ "0YTSG000000PgSH4A0" \], "refund": { "premium": "133.4", "tax": "21.3", "fee": "32.3" }, "sortOrder": -1, "version": 1 } } } # Cancel Policy The policy cancellation process addresses the termination of an insurance policy before its scheduled expiration date. Common reasons for canceling a policy include not paying the premiums or a direct cancellation request from the policyholder. Make sure you have these details. - Policy ID of the active insurance policy to be canceled. - Effective date of cancellation. This date determines when ‌coverage ceases and is a required input for the policy cancellation API. This diagram outlines a sequence of operations involved in canceling a policy. ![A flow diagram representing the cancel policy user journey.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/cancel_policy.png) 1. Use the policy ID to cancel the policy either by: - Making a POST request on the [Cancel Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cancel_policy.htm "HTML (New Window)") Connect API, or - Using the [Cancel Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_cancel_insurance_policy.htm "HTML (New Window)") invocable action. You can specify a name for the transaction record that’s created as part of the cancellation process. The transaction record is used for tracking financial implications, such as refunds. This process returns the details of the policy versions that are canceled, which include the current version and any future-dated versions. Details of any applicable refunds, such as premium refunds and tax refunds, calculated by the system based on the cancellation date and policy terms are also returned by the API. **Expected Results:** - The specified policy is marked as Cancelled in Salesforce. - The policy's effective-to-date field is updated to the day immediately preceding the effective date of cancellation that's specified during the API call. - Any future-dated policy versions associated with the canceled policy are also automatically canceled. - Information regarding applicable premium and tax refunds are shown in the API response, which can then be used for downstream financial processing. - A transaction record is created and linked to the cancellation event. # Cancel Policy Output representation of cancel policy details. ## JSON Example { "impactedPolicyVersions": \[ "0YTxx000000006TGAQ" \], "refund": { "fee": 15.71, "premium": 31.42, "tax": 15.71 } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | impactedPolicyVersions | String\[\] | List of impacted policy versions. | Small, 63.0 | 63.0 | | refund | [Refund](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_refund_output.htm "Output representation of refund details.")\[\] | Refund associated with cancellation operation. | Small, 63.0 | 63.0 | # Cancel Policy (PATCH) Cancel an insurance policy. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/cancel ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx0000000001GAA/cancel ## Available Version 67.0 ## HTTP Methods PATCH ## Request Parameters for PATCH | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | policyId | Id | ID of the insurance policy to cancel. The key prefix is 0YT. | Required | ## Request Body for PATCH ### JSON Example { "cancellationEffectiveDate": "2026-07-01", "cancellationReason": "Non-payment", "status": "Cancelled" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cancellationEffectiveDate | String | Date after which the policy is no longer valid. Use the format YYYY-MM-DD. | Required | 67.0 | | cancellationReason | String | Reason for canceling the insurance policy. | Optional | 67.0 | | status | String | Target status of the canceled policy, such as Canceled. | Optional | 67.0 | ## Response Body for PATCH [Insurance Policy Cancellation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_cancellation_output.htm "Output representation details of the cancel policy request.") # Cancel Policy Input Input Representation of cancel policy details. ## JSON Example { "effectiveDate": "2024-09-08", "transactionRecord":{ "name" : "Cancel Transaction" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the cancellation of the policy goes into effect. | Required | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.")\[\] | The JSON structure that overrides the transaction information. | Optional | 63.0 | # CancelClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId) Cancel payment for a claim coverage payment detail record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.CancelClaimCoveragePaymentDetailRep CancelClaimCoveragePaymentDetail(String claimId, String coverageId, String paymentDetailId) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage record. **paymentDetailId** - Type: String - ID of the claim coverage payment detail record. ## Return Value Type: [ConnectApi.CancelClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_cancel_claim_coverage_payment_detail.htm "Output representation for the details of the cancel claim coverage payment detail record.") ## Example Use this Apex sample to cancel a claim coverage payment detail record using the Cancel Claim Coverage Payment Detail API. This example shows how to invoke the Connect API method ConnectApi.InsuranceClaimFamily.CancelClaimCoveragePaymentDetail() and handle success and error responses in Apex. **Class Definition** This Apex example shows how to cancel a specific claim coverage payment detail for a given claim and coverage. public with sharing class CancelClaimCoveragePaymentDetailCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'cancelClaimCoveragePaymentDetail') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); String claimCoveragePaymentDetailId = (String) inputMap.get('claimCoveragePaymentDetailId'); System.debug('Start of connect API call to cancel claim coverage payment detail'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); System.debug('Claim Coverage Payment Detail ID: ' + claimCoveragePaymentDetailId); // Initialize the output representation ConnectApi.CancelClaimCoveragePaymentDetailRep paymentDetailData; try { // Call the Connect API resource using the correct method signature // Endpoint: /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/cancelPayment paymentDetailData = ConnectApi.InsuranceClaimFamily.cancelClaimCoveragePaymentDetail( claimId, claimCoverageId, claimCoveragePaymentDetailId ); System.debug('Claim coverage payment detail cancelled successfully: ' + paymentDetailData); // Add results to output map outputMap.put('paymentDetailData', paymentDetailData); outputMap.put('isCancelled', paymentDetailData.isSuccess); // Handle errors if present if (paymentDetailData.errors != null && !paymentDetailData.errors.isEmpty()) { outputMap.put('errors', paymentDetailData.errors); System.debug('Errors found: ' + paymentDetailData.errors); } } catch (Exception e) { System.debug('Error while canceling claim coverage payment detail: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isCancelled', false); } return paymentDetailData; } // Return null if the action is unrecognized return null; } } **Usage Example** Use the CancelClaimCoveragePaymentDetailCallable class to execute the cancelClaimCoveragePaymentDetail action and process the result. CancelClaimCoveragePaymentDetailCallable callable = new CancelClaimCoveragePaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); input.put('claimId', '0ZkXK00000000010AA'); // Claim ID input.put('claimCoverageId', '0kPXK00000000012AA'); // Claim Coverage ID input.put('claimCoveragePaymentDetailId', '0l2XK000000006TYAQ'); // Claim Coverage Payment Detail ID // Prepare output and argument maps Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'cancelClaimCoveragePaymentDetail' action Object result = callable.call('cancelClaimCoveragePaymentDetail', args); // Check the result if (result != null) { System.debug('Claim coverage payment detail processed successfully: ' + result); // Access the processed payment detail data ConnectApi.CancelClaimCoveragePaymentDetailRep paymentDetailData = (ConnectApi.CancelClaimCoveragePaymentDetailRep) result; // Process the result System.debug('Payment Detail Data: ' + paymentDetailData); if (paymentDetailData.isSuccess) { System.debug('Cancellation was successful'); } else { System.debug('Cancellation failed'); if (paymentDetailData.errors != null) { System.debug('Error details: ' + paymentDetailData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # cancelInsurancePolicy(insurancePolicyCancelInput, policyId) Cancel a specific insurance policy by providing the cancellation details and the policy ID. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyCancellationRepresentation cancelInsurancePolicy(ConnectApi.InsurancePolicyCancellationInputRepresentation insurancePolicyCancelInput, String policyId) ## Parameters **insurancePolicyCancelInput** - Type: [ConnectApi.InsurancePolicyCancellation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_cancellation.htm "Input representation for the cancel policy request. Includes the cancellation effective date, the cancellation reason, and the target status for the canceled policy.") - Input representation containing the cancellation effective date, reason, and target status for the canceled policy. **policyId** - Type: String - ID of the insurance policy to cancel. ## Return Value Type: [ConnectApi.InsurancePolicyCancellationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_cancellation.htm "Output representation for the cancel policy response. Contains the transaction ID, a list of impacted policy versions, and any errors that occurred during the cancellation process.") ## Usage Use this method to cancel a specific insurance policy. Provide the cancellation effective date, reason, and target status in the input representation, along with the ID of the policy to cancel. The policy is canceled synchronously, and the response includes the transaction ID, impacted policy versions, and any errors. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.cancelInsurancePolicy() method to cancel a specific insurance policy. **Class Definition** This Apex example shows how to cancel an insurance policy. global class CancelConnectDriver { global static void callCancelConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); ConnectApi.InsurancePolicyCancellationInputRepresentation cancelInput = new ConnectApi.InsurancePolicyCancellationInputRepresentation(); cancelInput.cancellationEffectiveDate = '2026-07-01'; cancelInput.status = 'Cancelled'; cancelInput.cancellationReason = 'Customer Request'; input.put('policyInput', cancelInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); CancelTestConnectAPI callable = new CancelTestConnectAPI(); Object result = callable.call('cancel', args); ConnectApi.InsurancePolicyCancellationRepresentation policyData = (ConnectApi.InsurancePolicyCancellationRepresentation) result; System.debug('Cancel Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the CancelTestConnectAPI class to execute the cancel action and process the result. public class CancelTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'cancel') { ConnectApi.InsurancePolicyCancellationInputRepresentation cancelInput = (ConnectApi.InsurancePolicyCancellationInputRepresentation) inputMap.get('policyInput'); String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to cancel policy: ' + policyId); ConnectApi.InsurancePolicyCancellationRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.cancelInsurancePolicy(cancelInput, policyId); System.debug('Policy cancelled successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while cancelling policy: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute CancelConnectDriver.callCancelConnectAPI(); # CancelPolicy(CancelPolicyInput, policyId) Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.CancelPolicyOutputRepresentation CancelPolicy(ConnectApi.CancelPolicyInputRepresentation CancelPolicyInput, String policyId) ## Parameters **CancelPolicyInput** - Type: [ConnectApi.CancelPolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_cancel_policy.htm "Input representation of the request to cancel a policy.") - Description **policyId** - Type: String - Input representation of the request to cancel a policy. ## Return Value Type: [ConnectApi.CancelPolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_cancel_policy_output.htm "Output representation details of cancel policy, such as impacted policy versions and refund associated with the cancellation.") ## Usage Send the cancellation effective date and transaction record in the request to cancel a policy. # Census Management Create, update, clone, and map group census members and their plans. - **[Generate Group Census From Insurance Contract Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_census.htm)** Asynchronously generate a group census containing member and plan configuration from the active insurance policies associated with an insurance contract. - **[Generate or Update Group Census Members Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_refresh_census_members.htm)** Generate or update group census members and their plan configuration details based on policy information from an insurance contract for one or more person accounts or contacts. - **[Get Group Census Members Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_group_census_members.htm)** Get the group census member records from the content document in the specified asynchronous bulk request item record. - **[Get Group Census Members and Plans Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_group_census_members_and_plans.htm)** Get the group census member records and associated plans from the content document in the specified asynchronous bulk request item record. - **[Create Contacts and Users from Group Census Members Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_contacts_users_from_group_census.htm)** Create contacts and portal users for group census or group census members. - **[Save Group Census Members Data Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_save_group_census_members_data.htm)** Create or update the group census member records for primary members, update the IDs of the dependent members, and create or update groups census member records for the dependent members. - **[Validate Group Census Members Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_validate_group_census_members.htm)** Validate the specified group census member records and assign default values to the specified fields. - **[Get Applicable Auto-Assigned Member Plans Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_applicable_auto_assigned_mbr_plans.htm)** Get a combined collection of group census member plans, including the specified plans and plans that are automatically assigned based on contract settings. - **[Save Group Census Member Plans Data Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_save_group_census_members_plans_data.htm)** Validate and save group census member plans for the new members. Update the group census member plans for existing members. - **[Validate Group Census Members Plans Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_validate_group_census_members_plans.htm)** Validate the specified group census member plan records and assign default values to the specified fields. - **[Create Person Accounts and Users from Group Census Members Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_person_accounts_users_from_group_census.htm)** Create person accounts and portal users for group census or group census members. This action supports bulk processing, custom field mapping, and duplicate detection. - **[Update Group Census Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_refresh_census.htm)** Asynchronously update a group census using the insurance contract data. Specify the date range, and the API updates the group census member and plan configuration details based on the policy enrollments or adjustments during the specified time period. # Census Management Create, update, clone, and map group census members and their plans. - **[Deep Clone Group Census (POST)](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. - **[Generate Census Information from Policies for Contract (POST)](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. - **[Update Census Information from Policies for Contract (POST)](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. - **[Group Census Members With Plans (POST, PATCH)](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. - **[Insurance Bulk Census Management (POST)](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. - **[Insurance Census Summary Sync (POST)](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. - **[Insurance Contacts and Users (POST)](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. - **[Insurance Group Census Members (POST, PATCH, DELETE)](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. - **[Insurance Group Census Members Delete (POST)](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. - **[Insurance Member Eligible Plans (GET)](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. - **[Insurance Member Plans (POST, PATCH)](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. - **[Insurance Member Plans Delete (POST)](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. - **[Insurance Person Accounts and Users (POST)](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. - **[Insurance Plans Eligibility Check (POST, PATCH)](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). - **[Group Census Member Plan Field Mapper (POST)](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. - **[Update Group Census (PATCH)](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. # Check Financial Authority Output representation of evaluating whether the current user has sufficient financial authority to approve a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount. ## JSON Example { "errors": \[\], "hasFinancialAuthority": true, "isFinancialAuthorityConfigured": true, "isPaymentAllowed": true, "isSuccess": true, "maximumApprovalAmount": 500.0, "requestedBy": "005xx000001X7mv" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | List of errors, including error codes and messages, returned when the evaluation doesn’t allow payment. Empty when the user has sufficient authority. Typical conditions include no matching User Financial Authority (UFA) record, a maximum approval amount of zero, the payment detail amount exceeding the user’s limit, or no further approver in the management hierarchy. | Big, 68.0 | 68.0 | | hasFinancial​Authority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | Big, 68.0 | 68.0 | | isFinancialAuthority​Configured | Boolean | Indicates whether a UFA record is configured for the current user for the payment detail’s product, financial type, and CCPD evaluation method (true) or not (false). | Big, 68.0 | 68.0 | | isPaymentAllowed | Boolean | Indicates whether payment is allowed for the evaluated claim coverage payment detail (true) or not (false), based on the UFA record configuration, the user’s financial authority, and the current payment detail status. | Big, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 68.0 | 68.0 | | maximumApproval​Amount | Double | Maximum approval amount for the current user from the matched UFA record. This value is null when no matching UFA record is found. | Big, 68.0 | 68.0 | | requestedBy | String | ID of the user whose financial authority was evaluated. This is the currently authenticated user who initiated the request. | Big, 68.0 | 68.0 | # Check Financial Authority (POST) Check whether the current user has sufficient financial authority to approve a claim coverage payment detail. The API matches a User Financial Authority (UFA) record to the payment detail’s product and financial type, compares the adjusted amount to the user’s maximum approval amount, and sets the payment detail status to Pending Authority when the limit is exceeded and a manager is available. ## Resource {paymentDetailId} is a placeholder. /connect/insurance/claims/payment-details/{paymentDetailId}/check-financial-authority ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/payment-details/0l2xx000000003gEAA/check-financial-authority ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | paymentDetailId | String | ID of the claim coverage payment detail record to evaluate for financial authority. The ID must start with 0l2. The API resolves its product and financial type (claim loss or claim expense), and compares the adjusted amount with the current user’s matching UFA record. | Required | 68.0 | ## Response Body for POST [Check Financial Authority](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_check_financial_authority.htm "Output representation of evaluating whether the current user has sufficient financial authority to approve a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount.") # Check Financial Authority Action Check whether the currently authenticated user has sufficient financial authority to approve a claim coverage payment detail record. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/checkFinancialAuthority Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | chkFinancialAuthorityInputRep | Apex-defined | Required. An Apex ConnectApi.ChkFinancialAuthorityInputRep record that contains the ID of the claim coverage payment detail record to check the user's financial authority. | ## Outputs | Output | Type | Description | | --- | --- | --- | | chkFinancialAuthorityOutputRep | Apex-defined | An Apex ConnectApi.ChkFinancialAuthorityOutputRep record that contains the result of the financial authority evaluation. | ## Example **POST** This sample request is for the Check Financial Authority action. { "inputs": \[ { "chkFinancialAuthorityInputRep": { "paymentDetailId": "0l2xx000000009hAAA" } } \] } This sample response is for the Check Financial Authority action. \[ { "actionName": "checkFinancialAuthority", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "chkFinancialAuthorityOutputRep": { "errors": \[ { "code": "SF-0009-0303", "message": "No User Financial Authority record was found for the current user." } \], "userHasFinancialAuthority": false, "userId": "005xx000001X7oX" } }, "sortOrder": -1, "version": 1 } \] # CheckFinancialAuthority(paymentDetailId) Check whether the current user has the financial authority to pay a specified claim coverage payment detail record. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.CheckFinancialAuthorityRep CheckFinancialAuthority(String paymentDetailId) ## Parameters **paymentDetailId** - Type: String - ID of the claim coverage payment detail record to evaluate. ## Return Value Type: [ConnectApi.CheckFinancialAuthorityRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_check_financial_authority_rep.htm "Contains the result of a financial authority check for a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount.") ## Example **Class Definition** /\*\* \* Callable wrapper to exercise the UFA (User Financial Authority) Connect API: \* POST /connect/insurance/claims/payment-details/${paymentDetailId}/check-financial-authority \* \* Backed by CheckFinancialAuthorityResourceImpl -> CheckFinancialAuthorityService. \* \* Mirrors the EditClaimCoveragePaymentDetailCallable pattern. All debug output is \* prefixed with \[UFA\] so it is easy to grep in the debug logs. \*/ public with sharing class CheckFinancialAuthorityCallable implements System.Callable { private static final String LOG\_PREFIX = '\[UFA\] '; public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'checkFinancialAuthority') { // paymentDetailId is the ClaimCoveragePaymentDetail record Id to evaluate. // It maps to the ${paymentDetailId} URL path parameter. String paymentDetailId = (String) inputMap.get('paymentDetailId'); // The CheckFinancialAuthorityInputRep body is currently EMPTY (no fields). // We still build/accept one so the call site matches the generated signature. ConnectApi.CheckFinancialAuthorityInputRep checkInputRep = (ConnectApi.CheckFinancialAuthorityInputRep) inputMap.get('CheckFinancialAuthorityInput'); if (checkInputRep == null) { checkInputRep = new ConnectApi.CheckFinancialAuthorityInputRep(); } System.debug(LOG\_PREFIX + '==== Start CheckFinancialAuthority Connect API call ===='); System.debug(LOG\_PREFIX + 'Running as user: ' + UserInfo.getUserId() + ' (' + UserInfo.getName() + ')'); System.debug(LOG\_PREFIX + 'paymentDetailId (ClaimCoveragePaymentDetail Id): ' + paymentDetailId); ConnectApi.CheckFinancialAuthorityRep checkResponse; try { // Generated Apex signature: (paymentDetailId, input) — path param first. checkResponse = ConnectApi.InsuranceClaimFamily.CheckFinancialAuthority( paymentDetailId, checkInputRep ); System.debug(LOG\_PREFIX + 'CheckFinancialAuthority completed. Raw response: ' + checkResponse); // Surface every field the output representation returns. outputMap.put('checkResponse', checkResponse); if (checkResponse != null) { outputMap.put('isSuccess', checkResponse.isSuccess); outputMap.put('requestedBy', checkResponse.requestedBy); outputMap.put('hasFinancialAuthority', checkResponse.hasFinancialAuthority); outputMap.put('isFinancialAuthorityConfigured', checkResponse.isFinancialAuthorityConfigured); outputMap.put('isPaymentAllowed', checkResponse.isPaymentAllowed); outputMap.put('maximumApprovalAmount', checkResponse.maximumApprovalAmount); System.debug(LOG\_PREFIX + 'isSuccess = ' + checkResponse.isSuccess); System.debug(LOG\_PREFIX + 'requestedBy = ' + checkResponse.requestedBy); System.debug(LOG\_PREFIX + 'hasFinancialAuthority = ' + checkResponse.hasFinancialAuthority); System.debug(LOG\_PREFIX + 'isFinancialAuthorityConfigured= ' + checkResponse.isFinancialAuthorityConfigured); System.debug(LOG\_PREFIX + 'isPaymentAllowed = ' + checkResponse.isPaymentAllowed); System.debug(LOG\_PREFIX + 'maximumApprovalAmount = ' + checkResponse.maximumApprovalAmount); if (checkResponse.errors != null && !checkResponse.errors.isEmpty()) { outputMap.put('errors', checkResponse.errors); System.debug(LOG\_PREFIX + 'Errors returned by service:'); for (ConnectApi.ErrorDetail err : checkResponse.errors) { System.debug(LOG\_PREFIX + ' code=' + err.code + ', message=' + err.message); } } else { System.debug(LOG\_PREFIX + 'No errors returned.'); } } } catch (Exception e) { System.debug(LOG\_PREFIX + 'EXCEPTION while calling CheckFinancialAuthority: ' + e.getMessage()); System.debug(LOG\_PREFIX + 'Stack trace: ' + e.getStackTraceString()); outputMap.put('error', e.getMessage()); outputMap.put('isSuccess', false); } System.debug(LOG\_PREFIX + '==== End CheckFinancialAuthority Connect API call ===='); return checkResponse; } System.debug(LOG\_PREFIX + 'Unrecognized action: ' + action); return null; } } **Usage Example** /\*\* \* Execute-Anonymous script to test the UFA CheckFinancialAuthority Connect API \* via CheckFinancialAuthorityCallable. \* \* To view logs: open Developer Console -> Logs, or set a Debug Level, then \* filter the log for the \[UFA\] prefix. \*/ CheckFinancialAuthorityCallable callable = new CheckFinancialAuthorityCallable(); // ----- Input ----- Map input = new Map(); // The ClaimCoveragePaymentDetail record Id to evaluate (maps to ${paymentDetailId}). input.put('paymentDetailId', '0l2SB000000CLsMYAW'); // <-- replace with a real CCPD Id // The CheckFinancialAuthorityInputRep body is currently empty (no fields to set). // Provided here for completeness / future-proofing. ConnectApi.CheckFinancialAuthorityInputRep checkInputRep = new ConnectApi.CheckFinancialAuthorityInputRep(); input.put('CheckFinancialAuthorityInput', checkInputRep); // ----- Output ----- Map output = new Map(); // ----- Args ----- Map args = new Map(); args.put('input', input); args.put('output', output); System.debug('\[UFA-TEST\] Invoking checkFinancialAuthority action...'); Object result = callable.call('checkFinancialAuthority', args); // ----- Inspect result ----- if (result != null) { ConnectApi.CheckFinancialAuthorityRep checkData = (ConnectApi.CheckFinancialAuthorityRep) result; System.debug('\[UFA-TEST\] Response received: ' + checkData); System.debug('\[UFA-TEST\] isSuccess = ' + checkData.isSuccess); System.debug('\[UFA-TEST\] requestedBy = ' + checkData.requestedBy); System.debug('\[UFA-TEST\] hasFinancialAuthority = ' + checkData.hasFinancialAuthority); System.debug('\[UFA-TEST\] isFinancialAuthorityConfigured = ' + checkData.isFinancialAuthorityConfigured); System.debug('\[UFA-TEST\] isPaymentAllowed = ' + checkData.isPaymentAllowed); System.debug('\[UFA-TEST\] maximumApprovalAmount = ' + checkData.maximumApprovalAmount); if (checkData.isSuccess == true) { if (checkData.isPaymentAllowed == true) { System.debug('\[UFA-TEST\] RESULT: Payment IS allowed for this CCPD.'); } else { System.debug('\[UFA-TEST\] RESULT: Payment is NOT allowed for this CCPD.'); } } else { System.debug('\[UFA-TEST\] RESULT: API reported failure.'); } if (checkData.errors != null && !checkData.errors.isEmpty()) { for (ConnectApi.ErrorDetail err : checkData.errors) { System.debug('\[UFA-TEST\] Error -> code=' + err.code + ', message=' + err.message); } } } else { System.debug('\[UFA-TEST\] No result returned. error=' + output.get('error')); } # Claim (GET, PATCH) Get or update a claim record and its associated claim items and participants. ## Resource {claimId} is a placeholder. /connect/claims/{claimId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/claims/0Zkxx000000001dEAA ## Available Version 65.0 ## HTTP Methods GET, PATCH ## Path Parameter for GET and PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim to get or update the details for. | Required | 65.0 | ## Response Body for GET [Claim Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_output.htm "Output representation for the details of a claim record.") ## Request Body for PATCH ### JSON Example { "name": "Claim for Auto Accident", "lossDate": "2025-10-23T15:41:10.446Z", "claimLossDate": "2025-09-15", "claimType": "Auto", "claimReason": "Rear-end collision", "claimReasonType": "Accident", "lossType": "Accident", "insurancePolicyId": "0YTx0000000001qEAA", "productCode": "AutoClaimRoot", "accountId": "001xx000003DGQyAAO", "expenseReserveAmount": 750.50, "expenseReserveAdjustmentReason": "Initial expense reserve", "lossReserveAmount": 5000.00, "lossReserveAdjustmentReason": "Initial loss reserve", "additionalFields": { "PoliceReportNumber": "SF2025-00817", "IsTotalLoss": false, "ReportedDate\_\_c": "2025-09-15" }, "options": { "executeConfigurationRules": "false" }, "attributes": { "list": \[ { "apiName": "WeatherConditions", "value": "Clear and Sunny" }, { "apiName": "NumberOfVehicles", "value": "2" } \] }, "items": { "list": \[ { "instanceKey": "item\_vehicle\_damage\_01", "name": "Damaged Rear Bumper and Trunk", "productCode": "AUTO-SEDAN-2023", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": { "list": \[ { "apiName": "DamageSeverity", "value": "Moderate" } \] }, "additionalFields": { "RepairEstimate": 2750, "Date\_Damage\_First\_Noticed\_\_c": "2025-09-15" }, "relatedObjects": { "list": \[ { "relatedRecordId": "001xx000003DGQzAAP", "relatedRecordObjName": "Account" } \] }, "participantInstanceKey": "participant\_driver\_01", "action": "update" } \] }, "participants": { "list": \[ { "instanceKey": "participant\_driver\_01", "contactId": "003xx000003DGQyAAO", "accountId": "001xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "isInjured": false, "roles": \[ "Driver", "Claimant" \], "additionalFields": { "StatementTaken": true }, "action": "update" } \] } } ### Properties
Name Type Description Required or Optional Available Version
accountId String ID of the account that's associated with the claim. Optional 65.0
additionalFields Object Additional standard or custom fields that are used to create or update insurance claim. Optional 65.0
attributes Claim Attribute Input[] Attributes of the claim product. Optional 65.0
claimLossDate String Date when the loss occurred.

This parameter doesn't accept time of incident. To specify both the date and time of loss, use the lossDate parameter.

Optional 66.0
claimReason String Reason for the claim. Optional 65.0
claimReasonType String Category that the claim reason belongs to. Optional 65.0
claimType String Type of claim. Optional 65.0
expenseReserve​AdjustmentReason String Reason for the expense reserve adjustment. Optional 68.0
expenseReserve​Amount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Optional 68.0
insurance​PolicyId String ID of the insurance policy on which the claim is raised. Optional 65.0
items Claim Item Input[] Details of the items that are associated with the claim. Optional 65.0
lossDate Date Date and time when the loss occurred.

You must specify both the date and time of the incident; otherwise, the API returns an error. To specify only the date of loss, use the claimLossDate parameter.

Optional 65.0
lossReserve​AdjustmentReason String Reason for the loss reserve adjustment. Optional 68.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Optional 68.0
lossType String Type of the loss for which the claim is initiated. Optional 65.0
name String Name of the claim. Optional 65.0
options Claim Options Input Options for creating or updating a claim. Optional 65.0
participants Claim Participant Input[] Claim participants that are associated with the claim. Optional 65.0
productCode String Product code of the claim product. Required to create a claim 65.0
## Response Body for PATCH [Claim Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_output.htm "Output representation for a created or updated claim.") # Claim (POST) Create a claim. ## Resource /connect/claims ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/claims ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "name": "INS-Auto-Claim-27868", "lossDate": "2025-10-23T15:41:10.446Z", "claimLossDate": "2025-09-15", "claimType": "Auto", "claimReason": "Rear-end collision", "claimReasonType": "Accident", "lossType": "Accident", "insurancePolicyId": "0YTx0000000001qEAA", "productCode": "AutoClaimRoot", "accountId": "001xx000003DGQyAAO", "expenseReserveAmount": 750.50, "expenseReserveAdjustmentReason": "Initial expense reserve", "lossReserveAmount": 5000.00, "lossReserveAdjustmentReason": "Initial loss reserve", "additionalFields": { "PoliceReportNumber": "SF2025-00817", "IsTotalLoss": false, "ReportedDate\_\_c": "2025-09-15" }, "options": { "executeConfigurationRules": "false" }, "attributes": { "list": \[ { "apiName": "WeatherConditions", "value": "Clear and Sunny" }, { "apiName": "NumberOfVehicles", "value": "2" } \] }, "items": { "list": \[ { "instanceKey": "item\_vehicle\_damage\_01", "name": "Damaged Rear Bumper and Trunk", "productCode": "AUTO-SEDAN-2023", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": { "list": \[ { "apiName": "DamageSeverity", "value": "Moderate" } \] }, "additionalFields": { "RepairEstimate": 2750, "Date\_Damage\_First\_Noticed\_\_c": "2025-09-15" }, "relatedObjects": { "list": \[ { "relatedRecordId": "001xx000003DGQzAAP", "relatedRecordObjName": "Account" } \] }, "participantInstanceKey": "participant\_driver\_01" } \] }, "participants": { "list": \[ { "instanceKey": "participant\_driver\_01", "contactId": "003xx000003DGQyAAO", "accountId": "001xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "isInjured": false, "roles": \[ "Driver", "Claimant" \], "additionalFields": { "StatementTaken": true } } \] } } ### Properties
Name Type Description Required or Optional Available Version
accountId String ID of the account that's associated with the claim. Optional 65.0
additionalFields Object Additional standard or custom fields that are used to create or update insurance claim. Optional 65.0
attributes Claim Attribute Input[] Attributes of the claim product. Optional 65.0
claimLossDate String Date when the loss occurred.

This parameter doesn't accept time of incident. To specify both the date and time of loss, use the lossDate parameter.

Optional 66.0
claimReason String Reason for the claim. Optional 65.0
claimReasonType String Category that the claim reason belongs to. Optional 65.0
claimType String Type of claim. Optional 65.0
expenseReserve​AdjustmentReason String Reason for the expense reserve adjustment. Optional 68.0
expenseReserve​Amount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Optional 68.0
insurance​PolicyId String ID of the insurance policy on which the claim is raised. Optional 65.0
items Claim Item Input[] Details of the items that are associated with the claim. Optional 65.0
lossDate Date Date and time when the loss occurred.

You must specify both the date and time of the incident; otherwise, the API returns an error. To specify only the date of loss, use the claimLossDate parameter.

Optional 65.0
lossReserve​AdjustmentReason String Reason for the loss reserve adjustment. Optional 68.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Optional 68.0
lossType String Type of the loss for which the claim is initiated. Optional 65.0
name String Name of the claim. Optional 65.0
options Claim Options Input Options for creating or updating a claim. Optional 65.0
participants Claim Participant Input[] Claim participants that are associated with the claim. Optional 65.0
productCode String Product code of the claim product. Required to create a claim 65.0
## Response Body for POST [Claim Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_output.htm "Output representation for a created or updated claim.") # Claim Attribute Output representation for a claim attribute. | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the product attribute. | Big, 65.0 | 65.0 | | value | String | Value for the product attribute. | Big, 65.0 | 65.0 | # Claim Attribute Input Input representation for claim attributes. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the claim attribute. | Optional | 65.0 | | value | String | Value for the claim attribute. | Optional | 65.0 | # Claim Coverage Output representation for a claim coverage. ## JSON Example { "isSuccess": true, "coverageId": "0kPxx000000002fEAA", "errors": \[\], "warnings": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | coverageId | String | ID of the claim coverage record. | Big, 65.0 | 65.0 | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Details of the errors that are associated with the API request. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 65.0 | 65.0 | | warnings | String\[\] | Warning messages that are generated when a claim coverage reserve amount exceeds the reserve amount defined at the claim level. The API operation still completes successfully. The messages identify which reserve limits are exceeded and by how much. | Small, 68.0 | 68.0 | # Claim Coverage (PATCH) Update a specific claim coverage record. ## Resource {claimId} and {coverageId} are placeholders. /connect/claims/{claimId}/coverages/{coverageId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA ## Available Version 65.0 ## HTTP Methods PATCH ## Path Parameter for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim to update the coverage for. | Required | 65.0 | | coverageId | String | ID of the coverage within the claim that must be updated. | Required | 65.0 | ## Request Body for PATCH ### JSON Example { "expenseReserveAmount": 500.00, "lossReserveAmount": 2000.00, "additionalFields": { "Status": "Pending Review" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Fields | Object | Additional standard or custom fields to update the record. | Optional | 65.0 | | expense​ReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | lossReserve​Amount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | ## Response Body for PATCH [Claim Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_coverage.htm "Output representation for a claim coverage.") # Claim Coverage (POST) Create a claim coverage record for the specified claim. ## Resource {claimId} is a placeholder. /connect/claims/{claimId}/coverages ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/claims/0Zkxx000000001dEAA/coverages ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim to create the coverages for. | Required | 65.0 | ## Request Body for POST ### JSON Example { "claimParticipantId": "0kaxx000000001dEAA", "claimItemId": "0koxx000000001dEAA", "insurancePolicyAssetId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "reserveProcessingMode": "Manual", "currencyIsoCode": "USD", "lossReserveAmount": 5000.00, "expenseReserveAmount": 750.50, "additionalFields": { "RequireInspection": true, "CoverageSubtype": "Collision-Standard" } } ### Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields to create or update the record. Optional 65.0
claimItemId String ID of the claim item. Required 65.0
claim​Participant​Id String ID of the claim participant that's associated with the claim coverage. Required 65.0
currency​IsoCode String Currency ISO code for reserve adjustments. Optional 65.0
expenseReserve​Amount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Optional 65.0
insurancePolicy​AssetId String ID of the asset covered by the insurance policy that's associated with the claim coverage. Optional 65.0
insurancePolicy​CoverageId String ID of the insurance policy coverage. Optional 65.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Optional 65.0
name String Name of the claim coverage. Optional 65.0
reserve​ProcessingMode String Specifies how financial reserves are managed when a claim coverage is created.

The default value is CoverageReserve.

Optional 65.0
## Response Body for POST [Claim Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_coverage.htm "Output representation for a claim coverage.") # Claim Coverage Input Input representation for creating a claim coverage. ## JSON Example { "claimParticipantId": "0kaxx000000001dEAA", "claimItemId": "0koxx000000001dEAA", "insurancePolicyAssetId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "reserveProcessingMode": "Manual", "currencyIsoCode": "USD", "lossReserveAmount": 5000.00, "expenseReserveAmount": 750.50, "additionalFields": { "RequireInspection": true, "CoverageSubtype": "Collision-Standard" } } ## Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields to create or update the record. Optional 65.0
claimItemId String ID of the claim item. Required 65.0
claim​Participant​Id String ID of the claim participant that's associated with the claim coverage. Required 65.0
currency​IsoCode String Currency ISO code for reserve adjustments. Optional 65.0
expenseReserve​Amount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Optional 65.0
insurancePolicy​AssetId String ID of the asset covered by the insurance policy that's associated with the claim coverage. Optional 65.0
insurancePolicy​CoverageId String ID of the insurance policy coverage. Optional 65.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Optional 65.0
name String Name of the claim coverage. Optional 65.0
reserve​ProcessingMode String Specifies how financial reserves are managed when a claim coverage is created.

The default value is CoverageReserve.

 Optional 65.0
# Claim Coverage Payment Adjustment Details Output representation for the claim coverage payment adjustment details. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | adjustedAmount | Double | Amount deducted from the Posted Amount based on the respective attribute category. | Big, 65.0 | 65.0 | | adjustment​Reason | String | Reason for the claim coverage payment adjustment such as deductible, copay, or coinsurance. | Big, 65.0 | 65.0 | # Claim Coverage Payment Detail Output representation for creating the claim coverage payment detail record. ## JSON Example { "adjustedAmount": 200.0, "adjustmentReason": "Deductible", "paymentDetailId": "0l2xx00000001grAAA", "insPolicyLimitTrackingIds": \[ "1TExx0000004DUuGAM", "1TExx0000004DUvGAM" \], "isSuccess": true, "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | adjustedAmount | Double | Amount after adjustments are made based on the current standings of the policy limits. | Small, 65.0 | 65.0 | | adjustmentReason | String | Reason for the claim coverage payment detail adjustment, such as deductible, copay, or coinsurance. | Small, 65.0 | 65.0 | | errors | [Error Detail \[\]](connect_responses_error_details.htm "Output representation of the error details.") | List of errors, including detailed information about each error. | Small, 65.0 | 65.0 | | insPolicyLimit​TrackingIds | List | IDs of the insurance policy limit tracking records. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Small, 65.0 | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record that's created. | Small, 65.0 | 65.0 | # Claim Coverage Payment Detail (POST) Create a claim coverage payment detail record. This also generates the related records for the Insurance Policy Limit Tracking and Claim Coverage Payment Adjustment records if applicable. ## Resource {claimId} and {coverageId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim for which the claim coverage payment detail record must be created. | Required | 65.0 | | coverageId | String | ID of the coverage that applies to the claim. | Required | 65.0 | ## Request Body for POST ### JSON Example { "claimedAmount": 1200.0, "recipientId": "001xx000003GN2rAAG", "coveragePaymentType": "Loss", "benefitName": "DentalCov", "description": "Dental cleaning and checkup.", "limitUnitCount": 1, "adjustedAmount": 1200.0, "additionalFields": { "State\_\_c": "CA", "LOB\_\_c": "Commercial" } } ### Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields that are used to create the claim coverage payment detail record. Optional 65.0
adjustedAmount Double Amount deducted from the Posted Amount based on the respective attribute category. Required when coveragePaymentType is Loss 65.0
benefitName String Name of the benefit that's associated with the product attribute's mapped scope as a sub-coverage. Required when coveragePaymentType is Loss 65.0
claimedAmount Double Amount requested by the claimant when submitting the loss. Required 65.0
coveragePayment​Type String Specifies the category of the payment. The value must be either Loss or Expense.

Loss refers to the payment related to the policyholder's covered damages.

Expense refers to costs associated with claim processing, such as vendor fees.

 Required 65.0
description String Description of the claim coverage payment detail record. Optional 65.0
limitUnitCount Integer Number of units for this claim coverage payment detail, such as the number of days for a rental car expense.

The default value is 1.

 Optional 65.0
recipientId String

ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor.

 Optional 65.0
## Response Body for POST [Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_coverage_payment_detail.htm "Output representation for creating the claim coverage payment detail record.") # Claim Coverage Payment Detail Edit (PATCH) Update an existing Claim Coverage Payment Detail (CCPD) record for both loss and expense types. For loss-type payments, the system automatically re-evaluates the claim by reversing previously applied limits and recalculating adjustments, such as deductible and copay before saving the updated payment. For expense-type payments, you can update fields, such as claim amount and recipient. These updates don't recalculate adjustments or policy limits. Before using this API, you must call the [Recalculate Adjustments (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_calculate_adjustments.htm) API to get the adjusted amount, and then use that value in the request body of the edit CCPD API. ## Resource {claimId}, {coverageId}, and {paymentDetailId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx0000000001CAA/coverages/0kPxx0000000001CAA/payment-details/0l2xx0000000001CAA ## Available Version 66.0 ## HTTP Methods PATCH ## Path Parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim. | Required | 66.0 | | coverageId | String | ID of the coverage that applies to the claim. | Required | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | Required | 66.0 | ## Request Body for PATCH ### JSON Example { "claimedAmount": 5000.00, "adjustedAmount": 5000.0, "recipientId": "001xx000003DGQyAAO", "name": "Rental Car Expense", "description": "Payment for 5 days of rental car usage", "limitUnitCount": 5, "status": "Draft", "additionalFields": { "State": "CA", "policyType": "Auto", "LOB\_\_c": "Personal" } } ### Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields that are used to update the claim coverage payment detail. Optional 66.0
adjustedAmount Double Adjusted amount of the claim. Required if claimedAmount is specified for a loss item. 66.0
claimedAmount Double Amount requested by the claimant when submitting the loss. Optional 66.0
description String Description of the claim line item. Optional 66.0
limitUnitCount Integer Number of units for this claim coverage payment detail, such as the number of days for a rental car expense. The default value is 1. Optional 66.0
name String Name of the claim coverage payment detail record. Optional 66.0
recipientId String ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor.

For a Loss item, the recipient is the policyholder or a third party. For an Expense item, the recipient ID represents a vendor or internal staff member.

 Optional 66.0
status String Current status of the claim coverage payment detail, such as Draft. Optional 66.0
## Response Body for PATCH [Edit Claim Coverage Payment Detail Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_edit_claim_coverage_payment_detail.htm "Output representation for the edited claim coverage payment detail.") # Claim Coverage Payment Detail Input Input representation for creating a claim coverage payment detail record. ## JSON Example { "claimedAmount": 1200.0, "recipientId": "001xx000003GN2rAAG", "coveragePaymentType": "Loss", "benefitName": "DentalCov", "description": "Dental cleaning and checkup.", "limitUnitCount": 1, "adjustedAmount": 1200.0, "additionalFields": { "State\_\_c": "CA", "LOB\_\_c": "Commercial" } } ## Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields that are used to create the claim coverage payment detail record. Optional 65.0
adjustedAmount Double Amount deducted from the Posted Amount based on the respective attribute category. Required when coveragePaymentType is Loss 65.0
benefitName String Name of the benefit that's associated with the product attribute's mapped scope as a sub-coverage. Required when coveragePaymentType is Loss 65.0
claimedAmount Double Amount requested by the claimant when submitting the loss. Required 65.0
coveragePayment​Type String Specifies the category of the payment. The value must be either Loss or Expense.

Loss refers to the payment related to the policyholder's covered damages.

Expense refers to costs associated with claim processing, such as vendor fees.

 Required 65.0
description String Description of the claim coverage payment detail record. Optional 65.0
limitUnitCount Integer Number of units for this claim coverage payment detail, such as the number of days for a rental car expense.

The default value is 1.

 Optional 65.0
recipientId String

ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor.

 Optional 65.0
# Claim Coverage Update Input Input representation for updating a claim coverage. ## JSON Example { "expenseReserveAmount": 500.00, "lossReserveAmount": 2000.00, "additionalFields": { "Status": "Pending Review" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Fields | Object | Additional standard or custom fields to update the record. | Optional | 65.0 | | expense​ReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | lossReserve​Amount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | # Claim Details Output representation for the details of a claim record. ## JSON Example { "claimId": "0Zkxx000000001dEAA", "name": "Claim for Auto Accident", "accountId": "001xx000003DGQyAAO", "insurancePolicyId": "0YTx0000000001qEAA", "lossDate": "2025-09-13", "expenseReserveAmount": 750.50, "lossReserveAmount": 5000.00, "claimAttributes": \[ { "apiName": "PoliceReportNumber", "value": "SF-2025-09-13-00123" } \], "participants": \[ { "id": "0kaxx000000001dEAA", "instanceKey": "part1", "contactId": "003xx000003DGQyAAO", "roles": \[ "Driver" \] } \], "items": \[ { "id": "0koxx000000001dEAA", "instanceKey": "item\_vehicle\_bumper\_01", "name": "Damaged Front Bumper", "productCode": "AUTO-BUMPER-SEDAN", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": \[ { "apiName": "DamageSeverity", "value": "Severe" } \], "additionalFields": { "RepairEstimate": 1575.50, "IsDrivable": false }, "relatedObjects": \[ { "relatedRecordId": "500xx000000OpQrStU", "relatedRecordObjName": "Police\_Report\_\_c" } \], "participantInstanceKey": "participant\_driver\_1" } \], "errors": \[\] }
Name Type Description Filter Group and Version Available Version
accountId String ID of the account that's associated with the claim. Big, 65.0 65.0
attributes Claim Attribute [] Attributes of the claim product. Big, 65.0 65.0
claimId String ID of the claim. Big, 65.0 65.0
claimLossDate String Date when the loss occurred.

This parameter doesn't show the time of incident.

 Big, 66.0 66.0
claimReason String Reason for the claim. Big, 65.0 65.0
claimReasonType String Category that the claim reason belongs to. Big, 65.0 65.0
claimType String Type of the claim. Big, 65.0 65.0
contextId String ID of the context. Big, 65.0 65.0
errors Error Detail [] List of errors, including detailed information about each error. Big, 65.0 65.0
expenseReserveAmount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Big, 68.0 68.0
insurancePolicyId String ID of the insurance policy on which the claim is raised. Big, 65.0 65.0
items Claim Item [] Details of the claim items. Big, 65.0 65.0
lossDate Date Date and time when the loss occurred. Big, 65.0 65.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Big, 68.0 68.0
lossType String Type of loss for which the claim is initiated. Big, 65.0 65.0
name String Name of the claim. Big, 65.0 65.0
participants Claim Participant [] Details of the claim participants. Big, 65.0 65.0
productCode String Product code of the claim product. Big, 65.0 65.0
# Claim Input Input representation for creating or updating a claim. ## Properties
Name Type Description Required or Optional Available Version
accountId String ID of the account that's associated with the claim. Optional 65.0
additionalFields Object Additional standard or custom fields that are used to create or update insurance claim. Optional 65.0
attributes Claim Attribute Input[] Attributes of the claim product. Optional 65.0
claimLossDate String Date when the loss occurred.

This parameter doesn't accept time of incident. To specify both the date and time of loss, use the lossDate parameter.

 Optional 66.0
claimReason String Reason for the claim. Optional 65.0
claimReasonType String Category that the claim reason belongs to. Optional 65.0
claimType String Type of claim. Optional 65.0
expenseReserve​AdjustmentReason String Reason for the expense reserve adjustment. Optional 68.0
expenseReserve​Amount Double Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. Optional 68.0
insurance​PolicyId String ID of the insurance policy on which the claim is raised. Optional 65.0
items Claim Item Input[] Details of the items that are associated with the claim. Optional 65.0
lossDate Date Date and time when the loss occurred.

You must specify both the date and time of the incident; otherwise, the API returns an error. To specify only the date of loss, use the claimLossDate parameter.

 Optional 65.0
lossReserve​AdjustmentReason String Reason for the loss reserve adjustment. Optional 68.0
lossReserveAmount Double Amount that's reserved to cover a potential payment for a loss. Optional 68.0
lossType String Type of the loss for which the claim is initiated. Optional 65.0
name String Name of the claim. Optional 65.0
options Claim Options Input Options for creating or updating a claim. Optional 65.0
participants Claim Participant Input[] Claim participants that are associated with the claim. Optional 65.0
productCode String Product code of the claim product. Required to create a claim 65.0
# Claim Item Output representation for the details of a claim item. ## JSON Example { "id": "0koxx000000001dEAA", "instanceKey": "item\_vehicle\_bumper\_01", "name": "Damaged Front Bumper", "productCode": "AUTO-BUMPER-SEDAN", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": \[ { "apiName": "DamageSeverity", "value": "Severe" } \], "additionalFields": { "RepairEstimate": 1575.5, "IsDrivable": false }, "relatedObjects": \[ { "relatedRecordId": "500xx000000OpQrStU", "relatedRecordObjName": "Police\_Report\_\_c" } \], "participantInstanceKey": "participant\_driver\_1" } | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Object | Additional standard or custom fields that are used to create claim items. | Big, 65.0 | 65.0 | | attributes | [Claim Attribute \[\]](connect_responses_claim_attribute_output.htm "Output representation for a claim attribute.") | Attributes of the claim item. | Big, 65.0 | 65.0 | | category | String | Category of the claim item. | Big, 65.0 | 65.0 | | id | String | ID of the claim item. | Big, 65.0 | 65.0 | | instanceKey | String | Unique identifier of the claim item. | Big, 65.0 | 65.0 | | insurance​Policy​CoverageId | String | ID of the specific policy coverage that applies to the claim item. | Big, 65.0 | 65.0 | | insuredItemId | String | ID of the insured item. | Big, 65.0 | 65.0 | | name | String | The name of the claim item. | Big, 65.0 | 65.0 | | participant​InstanceKey | String | Unique identifier that's used to link a claim item to a specific participant. | Big, 65.0 | 65.0 | | productCode | String | Product code of the claim product. | Big, 65.0 | 65.0 | | relatedObjects | [Claim Related Object \[\]](connect_responses_claim_related_object_output.htm "Output representation for a related object on a claim.") | Related claim item records. | Big, 65.0 | 65.0 | # Claim Item Input Input representation for a claim item. ## Properties
Name Type Description Required or Optional Available Version
action String Action to perform on the record, such as create, update, and delete.

Supported only for Claims (PATCH) requests that add, update, or remove a claim item.

 Required to update claim item 65.0
additional​Fields Object Additional standard or custom fields for the claim item. Optional 65.0
attributes Claim Attribute Input[] Attributes of the claim item. Optional 65.0
category String Category of the claim item. Required 65.0
instanceKey String Unique identifier of the claim item. Optional 65.0
insurancePolicy​CoverageId String ID of the insurance policy coverage that applies to the claim item. Optional 65.0
insuredItemId String ID of the insured item that's involved in the claim. Optional 65.0
name String Name of the claim item. Optional 65.0
participant​InstanceKey String Unique identifier that's used to link a claim item to a specific participant. Optional 65.0
productCode String Product code of the claim item product. Required 65.0
relatedObjects Claim Related Object Input[] Related claim item records. Optional 65.0
# Claim Options Input Input representation for claim options. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | execute​Configuration​Rules | String | Specifies whether to execute configuration rules or not. | Optional | 65.0 | # Claim Participant Output representation for the details of a claim participant. ## JSON Example "participants": \[ { "id": "0kaxx000000001dEAA", "instanceKey": "participant\_driver\_1", "accountId": "001xx000003DGQyAAO", "contactId": "003xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "roles": \[ "Driver", "Claimant" \] } \] | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Account ID of the claim participant. | Big, 65.0 | 65.0 | | contactId | String | Contact ID of the claim participant. | Big, 65.0 | 65.0 | | id | String | ID of the claim participant. | Big, 65.0 | 65.0 | | instanceKey | String | Instance key of the claim participant. | Big, 65.0 | 65.0 | | insurance​Policy​ParticipantId | String | ID of the insurance policy participant that's related to the claim. | Big, 65.0 | 65.0 | | roles | String\[\] | Roles of the claim participant. | Small, 65.0 | 65.0 | # Claim Participant Input Input representation for a claim participant. ## JSON Example \[ { "instanceKey": "participant\_driver\_01", "contactId": "003xx000003DGQyAAO", "accountId": "001xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "isInjured": false, "roles": { "list": \[ "Driver", "Claimant" \] }, "additionalFields": { "StatementTaken": true }, "action": "update" } \] ## Properties
Name Type Description Required or Optional Available Version
accountId String Account ID of the claim participant. Optional 65.0
action String Action to perform on the participant record, such as create, update, or delete.

Supported only for Claims (PATCH) requests that add, update, or remove a claim participant.

 Required to update claim participant 65.0
additional​Fields Object Additional standard or custom fields to add details for the claim participant. Optional 65.0
contactId String Contact ID of the claim participant. Optional 65.0
instanceKey String Unique identifier for the participant. Optional 65.0
insurancePolicy​ParticipantId String ID of the insurance policy participant that's related to the claim. Optional 65.0
isInjured String Specifies if the participant is injured or not. Optional 65.0
roles String[] Roles of the claim participant. Required 65.0
# Claim Related Object Output representation for a related object on a claim. ## JSON Example { "relatedObjects": \[ { "relatedRecordId": "500xx000000OpQrStU", "relatedRecordObjName": "Police\_Report\_\_c" } \] } | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | related​RecordId | String | ID of the related claim item record. | Big, 65.0 | 65.0 | | relatedRecord​ObjName | String | Object name of the related claim item record. | Big, 65.0 | 65.0 | # Claim Related Object Input Input representation for a related object on a claim. ## JSON Example { "relatedObjects": \[ { "relatedRecordId": "500xx000000OpQrStU", "relatedRecordObjName": "Police\_Report\_\_c" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordId | String | ID of the related claim item record. | Optional | 65.0 | | recordObjName | String | Object name of the related claim item record. | Optional | 65.0 | # Claim Response Output representation for a created or updated claim. ## JSON Example { "claimId": "0Zkxx000000001dEAA", "isSuccess": true, "errors": \[\] } ## Properties | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim that's created or updated. | Big, 65.0 | 65.0 | | errors | [Error Detail\[\]](connect_responses_error_details.htm "Output representation of the error details.") | List of errors, including detailed information about each error. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # Claims Processing Journey A claim is a formal request submitted by a policyholder to receive benefits or compensation for a covered loss under an active insurance policy. A claim journey begins when the policyholder reports an incident, such as damage, injury, or another qualifying event that they believe is covered by their policy. A valid claim requires an active insurance policy, a reported loss date, and an incident that falls within the policy's covered benefits. Once initiated, the claim process includes creating policy limits for the policyholder, verifying policy coverage, creating a claim record, collecting supporting claim items and participant details, routing the claim for adjuster review, assessing eligibility and damages, performing financial calculations, and determining the payout amount. The process concludes with issuing payment for the claim. As an exception, the process also concludes when the customer withdraws the claim or when the payment is voided because it was initiated based on inaccurate data. This diagram outlines the sequence of operations that are involved in the claim process. ![A flow diagram representing the user journey for managing claims.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/insurance_claims_workflow.png) 1. **Create Policy Limits**—Generate a record of the trackable policy or coverage attributes, such as deductibles and limits, and store the record details in a separate entity. You can create policy limits by either: - Making a POST request on the [Policy Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_generate_policy_limits.htm "HTML (New Window)") Connect API, or - Using the [Create Policy Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_policy_limits.htm "HTML (New Window)") invocable action. **Result:** The system retrieves the financial rules for the policyholder’s specific policy, including deductible and coverage limits. 2. **Verify Policy Coverage**—Validate whether the policy covers the type of claim being submitted by either: - Making a POST request on the [Verify Policy Coverage](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_verify_policy_coverage.htm "HTML (New Window)") Connect API, or - Using the [Verify Coverage](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_verify_policy_coverage.htm "HTML (New Window)") invocable action. Specify the policyId and coverageId during the API call. **Result:** The system returns coverage details indicating whether the claim is eligible under the policy’s coverage rules or not. 3. **Create Claim**—Create a new claim for the covered incident, including related details, such as involved items and participants. Create a claim by either: - Making a POST request on the [Claim](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_claim.htm "HTML (New Window)") Connect API, or - Using the [Create Claim](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_claim.htm "HTML (New Window)") invocable action. **Result:**A unique claim ID is generated. The claim is submitted for review to a claims adjuster. 4. **(Optional)Update Claim**—Update an existing claim, including its items and participant details by either: - Making a PATCH request on the [Claim](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_claim.htm "HTML (New Window)") Connect API, or - Using the [Update Claim](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_claim.htm "HTML (New Window)") invocable action. **Result:** The claim record is updated, and its status changes from New to Pending Review. 5. **Invoke Claim Workflow Rules**—Route the claim for automated or manual review by triggering the underwriting API by either: - Making a POST request on the [Insurance Invoke Underwriting Rule](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_underwriting_rules_invoke.htm "HTML (New Window)") Connect API, or - Using the [Invoke Underwriting Rules](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_invoke_underwriting_rules.htm "HTML (New Window)") invocable action. **Result:** The system evaluates claim parameters, such as claim amount and type, and assigns it to a claims adjuster or workflow queue. 6. **Open Claim Coverage**—Open a claim coverage record that tracks the coverage-level reserves, payments, and other financial transactions, and maps them to the corresponding insurance policy coverage, asset, or participant. Open a claim coverage by either: - Making a POST request on the [Claim Coverage](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_claim_coverage.htm "HTML (New Window)") Connect API, or - Using the [Open Claim Coverage](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_open_claim_coverage.htm "HTML (New Window)") invocable action. **Result:** The claim coverage record is created that’s used to store and track the associated payment details for the claim. 7. **Calculate Adjustments**—Calculate how much the insurer must pay after applying adjustments to the policy’s deductible, copay, coinsurance, and out-of-pocket maximums (OOPM). Calculate the adjusted amount by either: - Making a POST request on the [Calculate Adjustments](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_calculate_adjustments.htm "HTML (New Window)") Connect API, or - Using the [Calculate Adjustments](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_calculate_adjustments.htm "HTML (New Window)") invocable action. **Result**: Financial details are computed and made available for payment generation. 8. **Create Claim Coverage Payment Detail (CCPD)**—Create a claim coverage payment detail record capturing the amount requested by the claimant. The record is used to track payment requests and associated claim coverage details. Create a CCPD by either: - Making a POST request on the [Create Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_calculate_adjustments.htm "HTML (New Window)") Connect API, or - Using the [Create Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_calculate_adjustments.htm "HTML (New Window)") invocable action. **Result:** A claim coverage payment detail (CCPD) record is created for the calculated payout amount. ## Standard Claim Resolution Flow (Successful Payment) When the reviewer approves the claim, use this sequence to process and complete payment. - **(Optional) Validate Payment Limits**—Before the payment is executed, the system must validate that the payout amount is within the policy’s applicable coverage limits, such as the collision limit or other coverage-specific maximums. This prevents overpayments and protects the insurer from financial leakage. Make a POST request to the [Process Policy Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_process_policy_limits.htm "HTML (New Window)") Connect API to ensure the payout is within policy limits. - **Execute Payment Transaction**Initiate the payment process by either: - Making a POST request on the [Pay Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_pay_claim_coverage_payment_detail.htm "HTML (New Window)") Connect API, or - Using the [Pay Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_pay_claim_coverage_payment_detail.htm) invocable action. ![Note](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/images/icon_note.png) #### Note When the Pay Claim Coverage Payment Detail Connect API is executed, it automatically invokes the Process Policy Limits Connect API to check the correctness of the payout amount. **Result:** The claim payment is processed successfully, and the policyholder receives a payment confirmation notification. The claim is marked Closed. ## Exception Flows **Void Payment Record**—The reviewer approves the claim based on inaccurate data. Before payment processing, the admin must void the incorrect CCPD record that's already created. Invalidate the payment record by either: - Making a POST request on the [Delete Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_delete_claim_coverage_payment_detail.htm "HTML (New Window)") Connect API, or - Using the [Delete Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_delete_claim_coverage_payment_detail.htm "HTML (New Window)") invocable action. The payment instruction is permanently deleted from the financial system, and the claim must be re-evaluated. **Cancel Payment**—After the Pay CCPD record is created and payment is initiated, policyholder withdraws the claim before payout. Cancel the payment by either: - Making a POST request on the [Cancel Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_delete_claim_coverage_payment_detail.htm "HTML (New Window)") Connect API, or - Using the [Cancel Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_delete_claim_coverage_payment_detail.htm "HTML (New Window)") invocable action. The payment instruction is formally canceled. The claim is logged as Canceled at Customer’s Request and closed with status Withdrawn. Any policy-related financial updates are rolled back, and the original policyholder information remains unchanged. # Clause Generation Options Input Input representation for clause generation options. ## JSON Example { "generateClausesAsync": true, "generateManualClauses": false, "saveContext": true } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | generate​Clauses​Async | Boolean | Indicates whether to generate clauses asynchronously (true) or not (false). | Optional | 65.0 | | generate​Manual​Clauses | Boolean | Indicates whether to generate clauses manually (true) or not (false). | Optional | 65.0 | | saveContext | Boolean | Indicates whether to save the context while generating the product clause (true) or not (false). | Optional | 65.0 | # Commission Processing (POST) Process commission statements in an asynchronous manner using a preconfigured batch job. ## Resource /connect/insurance/brokerage/commission/process ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/commission/process ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "commissionStatementIds": \[ "199TC0000003kxZYAQ" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | commissionStatementIds | Object | List of commission statement IDs to be processed. | Required | 63.0 | ## Response Body for POST [Insurance Commission Processing](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_commission_processing_output.htm "Output representation details of the commission processing.") # Commission Processing Details Output representation details of the commission processing. ## JSON Example This example shows a sample success response. { "status": "Success", "message": "The processing has started for the commission statement CS-00000001." } This example shows a sample error response. { "status": "Fail", "message": "Processing failed for the commission statement The processing has started for the commission statement CS-00000001 ." }
Property Name Type Description Filter Group and Version Available Version
message String Status message of the API execution. Small, 63.0 63.0
status String Status of the API execution. Valid values are:
  • Success
  • Fail
 Small, 63.0 63.0
# Common Error Codes Contains the error codes and error code messages that are applicable to all Insurance APIs across all Insurance families. | Error Code | HTTP Response Code | Message | | --- | --- | --- | | SF-0001-0001 | 400 | Specify a context ID of type {expectedContextType}. | | SF-0001-0002 | 400 | The {dateField1} must be after the {dateField2}. | | SF-0001-0003 | 400 | Specify a date in yyyy-MM-dd format. | | SF-0001-0004 | 400 | Specify an input for {inputField}. | | SF-0001-0005 | 400 | Specify a valid input for {inputField}. | | SF-0001-0006 | 400 | Specify a valid context ID. | | SF-0001-0007 | 400 | Your input is invalid. Specify a valid payload and try again. | | SF-0001-0008 | 400 | Specify the default picklist value for an attribute in {entity} and try again. | | SF-0001-0009 | 400 | Something went wrong. Check the following error and try again: {errorMessage}. If the issue persists, contact your Salesforce admin for help. | | SF-0001-0010 | 400 | An internal error has occurred. Contact your Salesforce admin for help. | | SF-0001-0011 | 400 | Looks like you don't have access to {operation} this {entity}. Your Salesforce admin can help with that. | | SF-0001-0012 | 400 | Field Excluded From Update. Error {errorMessage} | | SF-0001-0013 | 400 | {errorMessage}. Check field names are correct and user has access to the specified fields | # Compute Producer Splits Action Compute the producer splits for the producers associated with an Insurance Policy, for a Commission Statement Line Item. This action is available in API version 63.0 and later. ## Special Access Rules The Compute Producer Splits action is available in Enterprise, Unlimited, and Developer Editions where where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need Insurance Commission Management and Insurance Brokerage User permission sets. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/computeProducerSplits Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | commissionStatementLineItemId | String | ID of the commission statement line item record. | ## Outputs | Output | Type | Description | | --- | --- | --- | | producerCommissions | sObject | Collection of producer commission records that are computed. | ## Example **POST** This sample request is for the Compute Producer Splits action. { "inputs": \[ { "commissionStatementLineItemId": "1Atxx0000004DeaCAE" } \] } This is the sample response for the Compute Producer Splits action. \[ { "actionName": "computeProducerSplits", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "producerCommissions": \[ { "attributes": { "type": "ProducerCommission" }, "CommissionStatementLineItemId": "1Atxx0000004C92CAE", "ProducerSplitAssignmentId": "1AIxx0000004C92GAE", "CommissionAmount": 4000, "InsurancePolicyId": "0YTxx0000000001GAA", "ProducerId": "0Yxxx0000000001CAA", "ProducerSplitArngLineItemId": "1BHxx0000004C92GAE", "Name": "CSLI-0000000001-Amol-Commission" } \] }, "sortOrder": -1, "version": 1 } \] # ConnectApi Input Classes Some ConnectApi methods take arguments that are instances of ConnectApi input classes. Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that have no parameters. Some methods have parameters that are typed with an abstract class. You must pass in an instance of a concrete child class for these parameters. Most input class properties can be set. Read-only properties are noted in this documentation. Insurance Brokerage includes these Apex input classes. - **[ConnectApi.InsuranceCommissionProcessingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_commission_processing.htm)** Input representation details of the insurance commission processing resource. The input includes the commissionStatementIds property required to process commission data. - **[ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk_field_map.htm)** Input representation for Insurance Policy Bulk Lifecycle process APIs with per-policy field value maps. - **[ConnectApi.InsurancePolicyBulkInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk.htm)** Input representation details to manage policies in bulk. - **[ConnectApi.InsurancePolicyBulkRenewInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_bulk_renew.htm)** Input representation details of the renew insurance policies in bulk resource. The input includes the list of insurance policy IDs to be renewed and the details of the associated fields of the insurance policies. - **[ConnectApi.InsurancePolicyRenewInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_renew.htm)** Input representation details of the resource to renew an insurance policy. - **[ConnectApi.InsuranceTransactionBillingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_transaction_billing.htm)** Input representation of the details to create billing schedules from an insurance transaction. - **[ConnectApi.InsurancePolicyReinstatementInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_reinstatement.htm)** Input representation for the reinstate policy request. Includes insurance policy field overrides and the reinstatement date. - **[ConnectApi.InsurancePolicyDraftInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_draft.htm)** Input representation for the endorsement draft request. Includes a field value map that specifies the insurance policy fields to override in the draft. - **[ConnectApi.InsurancePolicyCancellationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_cancellation.htm)** Input representation for the cancel policy request. Includes the cancellation effective date, the cancellation reason, and the target status for the canceled policy. - **[ConnectApi.PremiumPreviewInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_premium_preview_input_rep.htm)** Input representation for a draft-state premium preview. Specify hierarchy-node references to compute, or leave the list empty to return only the policy-root amounts. - **[ConnectApi.PremiumPreviewReferenceRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_premium_preview_reference_rep.htm)** Input representation of a reference to a node in the insurance policy hierarchy whose rolled-up premium amounts you want to preview. # ConnectApi Input Classes Some ConnectApi methods take arguments that are instances of ConnectApi input classes. Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that have no parameters. Some methods have parameters that are typed with an abstract class. You must pass in an instance of a concrete child class for these parameters. Most input class properties can be set. Read-only properties are noted in this documentation. Insurance Claim includes these Apex input classes. - **[ConnectApi.CalculateAdjustmentsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_calculate_adjustments.htm)** Input representation for calculating adjustments for claim loss items. - **[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm)** Input representation for the details of the additional field. - **[ConnectApi.ClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim.htm)** Input representation for creating or updating a claim. - **[ConnectApi.ClaimAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute.htm)** Input representation for claim attributes. - **[ConnectApi.ClaimAttributeInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute_input_re.htm)** Invocable action input representation for claim attributes. - **[ConnectApi.ClaimItemInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item.htm)** Input representation for claim items. - **[ConnectApi.ClaimItemInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item_input_re.htm)** Invocable action input representation for claim item. - **[ConnectApi.ClaimItemRelatedObjectInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item_related_object_input_re.htm)** Invocable action input representation for the related object in claim items. - **[ConnectApi.ClaimOptionsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_options.htm)** Input representation for claim options. - **[ConnectApi.ClaimOptionInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_options_input_re.htm)** Invocable action input representation for claim options - **[ConnectApi.ClaimParticipantInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_participant.htm)** Input representation for a claim participant. - **[ConnectApi.ClaimParticipantInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_participant_input_re.htm)** Invocable Action Input representation for Claim Participant - **[ConnectApi.ClaimRelatedObjectInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_related_object.htm)** Input representation for a related object on a claim. - **[ConnectApi.CreateClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim.htm)** Input representation for the Create Claim action. - **[ConnectApi.CreateClaimCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim_coverage.htm)** Input representation for creating a claim coverage. - **[ConnectApi.CreateClaimCovPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim_coverage_payment_detail.htm)** Input representation for creating a claim coverage payment detail record. - **[ConnectApi.CreatePolicyLimitsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_policy_limits.htm)** Input representation for creating insurance policy limit records. - **[ConnectApi.CreatePolicyLimitsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_policy_limits_input_re.htm)** Input representation for the apex ConnectApi.CreatePolicyLimitsInputRep record that contains the details of the policy limits to be created. - **[ConnectApi.DeleteClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_delete_claim_cvr_pymt_dtl_input_re.htm)** Input representation for deleting claim coverage payment detail operations - **[ConnectApi.EditClaimCvrPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_edit_claim_cvr_payment_detail.htm)** Input representation for editing claim coverage payment detail. - **[ConnectApi.GetClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_get_claim.htm)** Input representation to get the details of a claim. - **[ConnectApi.GetInsPlcyCurrStndInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_get_ins_plcy_curr_stnd_input_re.htm)** An Apex ConnectApi.GetInsPlcyLmtCurrStndInputRep record that contains the details needed to retrieve the consumed and available limits for the policy or claim. - **[ConnectApi.IPLStandingCalcOptions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_i_p_l_standing_calc_option.htm)** Invocable action input representation for options to calculate standings. - **[ConnectApi.InsPolicyLmtCurrentStandingsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_lmt_current_standings.htm)** Input representation for the current standings of the insurance policy limits. - **[ConnectApi.LimitStandingOptionInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_limit_standing_option.htm)** Input representation for limit standing options. - **[ConnectApi.OpenClaimCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_open_claim_coverage_input_re.htm)** Input representation for the open claim coverage action. - **[ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_coverage_payment_detail.htm)** Input representation for paying a claim coverage payment detail. - **[ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_coverage_payment_detail_options.htm)** Optional toggles that control which pre-payment checks run for a claim coverage payment detail. - **[ConnectApi.PayClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_cvr_pymt_dtl_input_re.htm)** Input representation for the Pay Claim Coverage Payment Detail action. - **[ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_ex_gratia_claim_cvr_payment_detail.htm)** Input representation for the ex gratia payment for the claim coverage payment detail. - **[ConnectApi.PayExGratiaClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_ex_gratia_claim_cvr_pymt_dtl_input_re.htm)** Input representation for the Pay Ex Gratia Claim Coverage Payment Detail action. - **[ConnectApi.ProcessPolicyLimitsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_process_policy_limits.htm)** Input representation for processing policy limits for a claim loss item. - **[ConnectApi.RecalculateAdjustmentsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_recalculate_adjustments.htm)** Input representation for recalculating the adjustments for existing payment details. - **[ConnectApi.UpdateClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim.htm)** Invocable action input representation for the update claim action. - **[ConnectApi.UpdateClaimCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim_coverage.htm)** Input representation for updating a claim coverage. - **[ConnectApi.UpdateClaimCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim_coverage_input_re.htm)** Input representation for the update claim coverage action. - **[ConnectApi.VerifyPolicyCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_verify_policy_coverage.htm)** Input representation for verifying a policy coverage's applicability for a specified loss date. - **[ConnectApi.VerifyPolicyCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_verify_policy_coverage_input_re.htm)** Invocable action input representation details to verify the coverage of a specific insurance policy. # ConnectApi Input Classes Some ConnectApi methods take arguments that are instances of ConnectApi input classes. Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that have no parameters. Some methods have parameters that are typed with an abstract class. You must pass in an instance of a concrete child class for these parameters. Most input class properties can be set. Read-only properties are noted in this documentation. Insurance Group Benefits includes these Apex input classes. - **[ConnectApi.AttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_attribute.htm)** Input representation for Group Census Member Plan attribute. - **[ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_accounts_and_users_creation.htm)** Input representation for creating person accounts and portal users from group census members. - **[ConnectApi.PortalUserCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_portal_user_creation.htm)** Input representation containing the details for creating a portal user. - **[ConnectApi.InsuranceContactsAndUsersCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contacts_and_users_creation.htm)** Input representation to create contacts and portal users. - **[ConnectApi.InsuranceMemberRatingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating.htm)** Input representation for the individual member rating API. - **[ConnectApi.InsuranceMemberRatingDetailsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating_details.htm)** Input representation for the details of an individual member to be rated. - **[ConnectApi.InsuranceMemberRatingPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating_plans.htm)** Input representation for plan details used in individual rating. - **[ConnectApi.InsuranceBulkCensusMgmtInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_bulk_census_mgmt.htm)** Input representation for managing employee census data in bulk. - **[ConnectApi.InsuranceCensusMgmtInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_mgmt.htm)** Input representation for adding or updating census members. - **[ConnectApi.GroupCensusMemberInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member.htm)** Input representation for a group census member. - **[ConnectApi.InsuranceUpdateMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_update_member_plans.htm)** Input representation for updating the plans for a group census member. - **[ConnectApi.InsuranceAddMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_add_member_plans.htm)** Input representation for adding plans to a group census member. - **[ConnectApi.GroupCensusMemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member_plan.htm)** Input representation for a single plan that's associated with a group census member. - **[ConnectApi.InsuranceDeleteMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_delete_member_plans.htm)** Input representation for deleting a member's plans. - **[ConnectApi.InsurancePlansEligibilityPatchInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_plans_eligibility_patch.htm)** Input representation for checking plan eligibility by updating an existing context. - **[ConnectApi.InsurancePlansEligibilityPostInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_plans_eligibility_post.htm)** Input representation for checking plan eligibility by creating a new context. - **[ConnectApi.InsuranceGroupPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_plan.htm)** Input representation for a contract group plan. - **[ConnectApi.InsuranceGroupRatingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_rating.htm)** Input representation for rating a group benefits quote. - **[ConnectApi.InsuranceIndividualEnrollmentInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_individual_enrollment.htm)** Input representation for enrolling an individual member. - **[ConnectApi.InsuranceIndividualMtaInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_individual_mta.htm)** Input representation for applying a mid-term adjustment to a group census member's insurance policies. - **[ConnectApi.InsuranceContractCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_creation.htm)** Input representation for creating contract. - **[ConnectApi.ContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_contract_ite.htm)** Addition fields to be added to the contract items. - **[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm)** Input representation for the Apex enabled string. - **[ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_create_quote_from_contract.htm)** Input representation for creating a quote from an existing insurance contract. - **[ConnectApi.InsuranceIssueContractInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_issue_contract.htm)** Input representation of the quote ID, optional contract dates and term, transaction detail level, and additional fields used to issue a group benefits contract from a quote. - **[ConnectApi.InsuranceContractEndorseInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_endorse.htm)** Input representation of the quote ID, endorsement effective date, optional date-copy behavior, and additional fields used to create an endorsed contract version from a quote. - **[ConnectApi.InsuranceContractRenewalInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_renewal.htm)** Input representation of the quote ID, renewal date, optional contract end date and term, and additional fields used to create a renewed-term contract from a quote. - **[ConnectApi.InsuranceGenerateCensusInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_census.htm)** Input representation of the census name and type, optional policy date, filters, and generation options used to create a group census from the policies on a contract. - **[ConnectApi.InsuranceRefreshCensusInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_refresh_census.htm)** Input representation of the group census ID, date range, optional filters, and update options used to refresh a group census from policy enrollments and endorsements on a contract. - **[ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_refresh_census_members.htm)** Input representation of the census details, member identifiers, optional policy date, and additional fields used to generate or update group census members from policy information on a contract. - **[ConnectApi.InsuranceGenerateRefreshCensusMembersAdditionalFieldsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_refresh_census_members_additional_fields.htm)** Input representation of the additional field values to apply to group census members during a generate or refresh census members operation. - **[ConnectApi.InsuranceUpsertMemberRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_upsert_member.htm)** Input representation of a group census member and the additional field values to apply during an upsert operation. - **[ConnectApi.InsuranceCensusFilterInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_filter.htm)** Input representation of the filter criteria that select which policy records to include when generating a group census from a contract. - **[ConnectApi.InsuranceContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_item.htm)** Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote. - **[ConnectApi.InsuranceQuoteItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_quote_item.htm)** Input representation for an insurance quote item that identifies an entity, product path, and additional field overrides. - **[ConnectApi.InsGBQuoteConfigOptions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_g_b_quote_config_options.htm)** Input representation for configuration options when creating an insurance group benefits quote. - **[ConnectApi.MembersWithPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_members_with_plans.htm)** Input representation for adding or updating a family of group census members and their insurance plans. - **[ConnectApi.MemberWithPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_with_plans.htm)** Input representation for the details of a group census member and the insurance plans to add, update, or remove for that member. - **[ConnectApi.MemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan.htm)** Input representation for an insurance plan that's assigned to a group census member. - **[ConnectApi.GroupbenefitsAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_groupbenefits_attribute.htm)** Input representation for an attribute value that overrides the value derived from the product on a group census member plan. - **[ConnectApi.GroupCensusDeepCloneInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_deep_clone.htm)** Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition. - **[ConnectApi.GroupCensusFieldMappingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_field_mapping.htm)** Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records. - **[ConnectApi.InsuranceGroupEndorsementInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_endorsement.htm)** Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census. - **[ConnectApi.InsuranceGroupRenewalInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_renewal.htm)** Input representation of the optional flow and repricing settings used to renew member policies for a group census. - **[ConnectApi.GroupCensusFiltersInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_filters.htm)** Input representation of the per-entity filters that scope which group census member plan records are processed. - **[ConnectApi.GroupCensusReferenceMappingsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_reference_mappings.htm)** Input representation of the per-entity reference values stamped on group census member plan records. - **[ConnectApi.MemberPlanFilterInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan_filter.htm)** Input representation of the filter that identifies which group census member plan records to process. - **[ConnectApi.MemberPlanReferenceMappingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan_reference_mapping.htm)** Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse. # ConnectApi Input Classes Some ConnectApi methods take arguments that are instances of ConnectApi input classes. Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that have no parameters. Some methods have parameters that are typed with an abstract class. You must pass in an instance of a concrete child class for these parameters. Most input class properties can be set. Read-only properties are noted in this documentation. Insurance Policy Administration includes these Apex input classes. - **[ConnectApi.AdditionalFieldIARep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_field_i_a_re.htm)** Input representation for the additional fields. - **[ConnectApi.AdditionalFieldsMapValue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_map_valu.htm)** AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap. - **[ConnectApi.AdditionalFieldsFieldSetInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_field_set.htm)** Input Representation for Additional Fields Field Set - **[ConnectApi.CancelPolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_cancel_policy.htm)** Input representation of the request to cancel a policy. - **[ConnectApi.EndorsePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_endorse_policy.htm)** Input representation of the request to endorse a policy. Context ID of the quote that’s used for endorsement and date that the endorsed policy version is effective from must be passed in the request. - **[ConnectApi.FieldSetIDsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_field_set_ids_input_re.htm)** List of the field set IDs for asset, coverage, participant, and policy objects. - **[ConnectApi.InsPolicyAddlInputIARep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_addl_input_i_a_re.htm)** Input representation for the additional fields of an insurance policy. - **[ConnectApi.InsurancePolicyBillingInfoInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_billing_info.htm)** Input representation for insurance policy billing. - **[ConnectApi.InsPolicyIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_i_a_input_re.htm)** Input representation details of an insurance policy. - **[ConnectApi.InsurancePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy.htm)** Input representation details of an insurance policy. - **[ConnectApi.InsPolicyTrxnIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_trxn_i_a_input_re.htm)** Input representation details of an insurance policy transaction. - **[ConnectApi.InsurancePolicyTransactionInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm)** Input representation details of an insurance policy transaction. - **[ConnectApi.IssuePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_issue_policy.htm)** Input representation of the request to issue an insurance policy. - **[ConnectApi.OutOfSequencePolicyEndorsementInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_out_of_sequence_endorse_policy_i_a_input_re.htm)** Input representation of the details to perform an out-of-sequence endorsement on an insurance policy. - **[ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_out_of_sequence_endorse_policy.htm)** Input representation of the details to perform an out-of-sequence endorsement on an insurance policy. - **[ConnectApi.ReinstatePolicyInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_reinstate_policy_i_a_input_re.htm)** Input representation for the Reinstate Insurance Policy Invocable Action. - **[ConnectApi.ReinstatePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_reinstate_policy.htm)** Input representation for reinstating an insurance policy. - **[ConnectApi.RenewPolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_renew_policy.htm)** Input representation of the request to renew a policy. - **[ConnectApi.RenewInsurancePoliciesIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_renew_ins_policy_async_i_a_input_re.htm)** An Apex ConnectApi.RenewInsurancePoliciesIAInputRep record that contains the details of the insurance policies to be renewed. # ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) in Insurance Brokerage provides classes for accessing the same data available in the Insurance Brokerage Business APIs. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm "HTML (New Window)"). - **[InsuranceBrokerageFamily Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_static_methods.htm)** Manage policy lifecycle, brokerage commissions, and plan benefits. - **[ConnectApi Input Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_apex_input_classes.htm)** Some ConnectApi methods take arguments that are instances of ConnectApi input classes. - **[ConnectApi Output Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_apex_output_classes.htm)** Most ConnectApi methods return instances of ConnectApi output classes. # ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) in Insurance Claim provides classes for accessing the same data available in the Insurance Policy Administration Business APIs. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm). - **[InsuranceClaimFamily Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_static_methods.htm)** Manage insurance claims. - **[ConnectApi Input Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_apex_input_classes.htm)** Some ConnectApi methods take arguments that are instances of ConnectApi input classes. - **[ConnectApi Output Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_apex_output_classes.htm)** Most ConnectApi methods return instances of ConnectApi output classes. # ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) in Insurance Design Advisor provides classes for accessing the same data available in the Insurance Design Advisor Business APIs. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm). - **[InsuranceDesignAdvisorFamily Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_static_methods.htm)** Use the Insurance Design Advisor Apex methods at design time to validate product model setup, attributes, pricing configuration, API request payloads, user permissions, and related insurance configuration before runtime. To use these methods, the org must have Insurance Design Advisor enabled. - **[Input Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_apex_input_classes.htm)** Some ConnectApi methods take arguments that are instances of ConnectApi input classes. - **[Output Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_apex_output_classes.htm)** Most ConnectApi methods return instances of ConnectApi output classes. # ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) in Insurance Group Benefits provides classes for accessing the same data available in the Insurance Group Benefits Business APIs. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm). - **[InsuranceGroupBenefitsFamily Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_static_methods.htm)** Effectively manage the insurance plans that are offered to groups, such as employees and their dependents, by using the Group Benefits feature on the Digital Insurance platform. Simplify the Group Benefits workflow through a unified platform for all processes, including census management, quote configuration and pricing, contract creation, and enrollment. - **[ConnectApi Input Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_apex_input_classes.htm)** Some ConnectApi methods take arguments that are instances of ConnectApi input classes. - **[ConnectApi Output Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_apex_output_classes.htm)** Most ConnectApi methods return instances of ConnectApi output classes. # ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) in Insurance Policy Administration provides classes for accessing the same data available in the Insurance Policy Administration Business APIs. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm). - **[InsurancePolicyAdminFamily Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_static_methods.htm)** Manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation. - **[ConnectApi Input Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_apex_input_classes.htm)** Some ConnectApi methods take arguments that are instances of ConnectApi input classes. - **[ConnectApi Output Classes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_apex_output_classes.htm)** Most ConnectApi methods return instances of ConnectApi output classes. # ConnectApi Output Classes Most ConnectApi methods return instances of ConnectApi output classes. All properties are read-only, except for instances of output classes created within the test code. All output classes are concrete unless marked abstract in this documentation. All concrete output classes have no-argument constructors that you can invoke only from the test code. See [Testing ConnectApi Code](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_TestingApex.htm "HTML (New Window)"). Insurance Brokerage includes these Apex output classes. - **[ConnectApi.InsuranceCommissionProcessingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_commission_processing_output.htm)** Output representation details of the commission processing resource. - **[ConnectApi.InsuranceOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_output.htm)** Output representation details of the bulk operations of the insurance policies. - **[ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm)** Output representation details of the bulk cancel policy resource. - **[ConnectApi.InsurancePolicyProcessOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_process_output.htm)** Output representation details of the insurance policy renewal resource. - **[ConnectApi.InsuranceTransactionBillingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_transaction_billing_output.htm)** Output representation of the result of creating billing schedules from an insurance transaction. - **[ConnectApi.InsurancePolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_output.htm)** Output representation of the insurance policy proration or rollup result. - **[ConnectApi.InsurancePolicyReinstatementRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_reinstatement.htm)** Output representation for the reinstate policy response. Contains the reinstated policy ID, the transaction ID, and any errors that occurred during the reinstatement process. - **[ConnectApi.InsurancePolicyIssueOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_issue_output.htm)** Output representation for the issue or endorse policy response. Contains the transaction ID and any errors that occurred during the process. - **[ConnectApi.InsurancePolicyDraftOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_draft_output.htm)** Output representation for the endorsement draft response. Contains the policy ID of the created draft and any errors that occurred during the process. - **[ConnectApi.InsurancePolicyCancellationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_cancellation.htm)** Output representation for the cancel policy response. Contains the transaction ID, a list of impacted policy versions, and any errors that occurred during the cancellation process. - **[ConnectApi.PremiumPreviewRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview.htm)** Output representation of a draft-state premium preview, including the policy ID and per-node rolled-up amount results. - **[ConnectApi.PremiumPreviewResultRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview_result.htm)** Output representation of per-node result from a draft-state premium preview, including rolled-up amounts or per-node errors. - **[ConnectApi.PremiumPreviewAmountsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview_amounts.htm)** Output representation of the rolled-up standard and term premium amounts for a single policy-hierarchy node. # ConnectApi Output Classes Most ConnectApi methods return instances of ConnectApi output classes. All properties are read-only, except for instances of output classes created within test code. All output classes are concrete unless marked abstract in this documentation. All concrete output classes have no-argument constructors that you can invoke only from test code. See [Testing ConnectApi Code](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_TestingApex.htm). Insurance Claim includes these Apex output classes. - **[ConnectApi.CalculateAdjustmentsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_calculate_adjustments.htm)** Output representation of the details for calculating the adjustments for the claim loss item. - **[ConnectApi.CancelClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_cancel_claim_coverage_payment_detail.htm)** Output representation for the details of the cancel claim coverage payment detail record. - **[ConnectApi.CheckFinancialAuthorityRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_check_financial_authority_rep.htm)** Contains the result of a financial authority check for a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount. - **[ConnectApi.ClaimAttributeOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_attribute_output.htm)** Output representation for a claim attribute. - **[ConnectApi.ClaimCovPaymentAdjDetailsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_cov_payment_adj_details.htm)** Output representation for the claim coverage payment adjustment details. - **[ConnectApi.ClaimCoverageRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_coverage.htm)** Output representation for a claim coverage operation. - **[ConnectApi.ClaimDetailOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_detail_output_re.htm)** Invocable action output representation for claim details. - **[ConnectApi.ClaimItemOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_output.htm)** Output representation for a claim item. - **[ConnectApi.ClaimItemOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_output_re.htm)** Invocable action output representation for claim item. - **[ConnectApi.ClaimItemOutputs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_outputs.htm)** Invocable action output representation for a wrapper that contains a list of claim items. - **[ConnectApi.ClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_output.htm)** Output representation for a retrieved claim. - **[ConnectApi.ClaimParticipantOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_output.htm)** Output representation for a claim participant. - **[ConnectApi.ClaimParticipantOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_output_re.htm)** Invocable action output representation for claim participant. - **[ConnectApi.ClaimParticipantOutputs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_outputs.htm)** Invocable action output representation for a wrapper that contains a list of claim participants. - **[ConnectApi.ClaimRelatedObjectOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_related_object_output.htm)** Output representation for a related object. - **[ConnectApi.CreateClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_claim_coverage_payment_detail.htm)** Output representation for the details of the create claim coverage payment detail record. - **[ConnectApi.CreateClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_claim_output.htm)** Output representation for a create or update claim operation. - **[ConnectApi.CreatePolicyLimitsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_policy_limits.htm)** Output representation of the created insurance policy limit records. - **[ConnectApi.DeleteClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_delete_claim_coverage_payment_detail.htm)** Output representation for the Delete Claim Coverage Payment Detail resource. - **[ConnectApi.EditClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_edit_claim_coverage_payment_detail.htm)** Output representation for editing claim coverage payment detail. - **[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm)** Output representation of an error. - **[ConnectApi.GetClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_claim_output.htm)** Output representation for the Get Claim action. - **[ConnectApi.GetInsPlcyCurrStndOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_ins_plcy_curr_stnd_output_re.htm)** An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy or claim. - **[ConnectApi.IPLStandingCalcAmounts](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_amount.htm)** Invocable action output representation for insurance policy limit standing calculation amounts. - **[ConnectApi.IPLStandingCalcCoverageInfo](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_coverage_inf.htm)** Output representation for insurance policy limit standing calculation. - **[ConnectApi.IPLStandingCalcLimitAttributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_limit_attribute.htm)** Invocable action output representation for limit attributes. - **[ConnectApi.IPLStandingCalcOutputNode](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_output_node.htm)** Node representation for the Insurance Policy Term Current Standing invocable action node. - **[ConnectApi.IPLStandingCalcValues](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_value.htm)** Invocable Action Output representation for IPL Standing Calculation Values - **[ConnectApi.IPLStandingMappedScopes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_mapped_scope.htm)** Invocable action output representation for insurance policy limit standing mapped scopes. - **[ConnectApi.InsPolicyLimitTrackingDetailsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_limit_tracking_details.htm)** Output representation for the insurance policy limit tracking details. - **[ConnectApi.InsPolicyLmtCalcStandingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_lmt_calc_standing.htm)** Output representation for the current standings of the insurance policy limits. - **[ConnectApi.InsPolicyLmtCalcStandingNode](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_lmt_calc_standing_node.htm)** Node representation for an insurance policy limit standing calculation. - **[ConnectApi.PayClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_claim_coverage_payment_detail.htm)** Output representation for a claim coverage payment detail operation. - **[ConnectApi.PayClaimCvrPymtDtlOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_claim_cvr_pymt_dtl_output_re.htm)** Output representation for the Pay Claim Coverage Payment Detail action. - **[ConnectApi.PayExGratiaClaimCvrPaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_ex_gratia_claim_cvr_payment_detail.htm)** Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail. - **[ConnectApi.PayExGratiaClaimCvrPymtDtlRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_ex_gratia_claim_cvr_pymt_dtl_rep.htm)** Output representation for the Pay Ex Gratia Claim Coverage Payment Detail action. - **[ConnectApi.ProcessPolicyLimitsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_process_policy_limits.htm)** Output representation for processing the policy limits for a claim loss item. - **[ConnectApi.RemainingReserveRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve.htm)** Output representation for the remaining reserve amount and scope after the payment is processed. - **[ConnectApi.RemainingReserveOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve_output.htm)** Output representation for the remaining reserve amount and scope after the payment is processed. - **[ConnectApi.VerifyPolicyCoverageRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_verify_policy_coverage.htm)** Output representation of a policy coverage's applicability for a specified loss date. - **[ConnectApi.VerifyPolicyCoverageOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_verify_policy_coverage_output_re.htm)** Invocable action output representation for verify policy coverage. # ConnectApi Output Classes Most ConnectApi methods return instances of ConnectApi output classes. All properties are read-only, except for instances of output classes created within test code. All output classes are concrete unless marked abstract in this documentation. All concrete output classes have no-argument constructors that you can invoke only from test code. See [Testing ConnectApi Code](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_TestingApex.htm). Insurance Group Benefits includes these Apex output classes. - **[ConnectApi.InsuranceAccountsAndUsersCreationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_accounts_and_users_creation.htm)** Output representation for the person account and user creation process. - **[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm)** Output representation for an error that occurred during an insurance process. - **[ConnectApi.InsuranceMemberAccountAndUserDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_account_and_user_details.htm)** Output representation that maps a source group census member to the IDs of the newly created person account and portal user. - **[ConnectApi.InsuranceContactsAndUsersCreationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contacts_and_users_creation.htm)** Output representation of the contact and user creation process. - **[ConnectApi.InsuranceMemberContactAndUserDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_contact_and_user_details.htm)** Output representation of the created contact and portal user details for a group census member. - **[ConnectApi.InsuranceMemberRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_rating.htm)** Output representation of the rating results for individual members. - **[ConnectApi.InsuranceMemberRatingDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_rating_details.htm)** Output representation of rating details for an individual member. - **[ConnectApi.InsurancePlanRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plan_rating.htm)** Output representation of pricing results for an individual plan. - **[ConnectApi.InsuranceCoverageRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_coverage_rating.htm)** Output representation of pricing results for an individual coverage. - **[ConnectApi.InsuranceContributionRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contribution.htm)** Output representation of contribution information in individual rating. - **[ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm)** Output representation for attributes and other mapped data. - **[ConnectApi.InsuranceBulkCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_bulk_census_mgmt.htm)** Output representation for the bulk employee census management process. - **[ConnectApi.InsuranceCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_mgmt.htm)** Output representation for the insurance census management process. - **[ConnectApi.InsuranceCensusSummarySyncOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_summary_sync.htm)** Output representation for the insurance employee census summary synchronization process. - **[ConnectApi.InsuranceGroupCensusOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_census.htm)** Output representation of a group census summary. - **[ConnectApi.InsuranceGrpCensusGrpClassSummaryOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_grp_census_grp_class_summary_output.htm)** Output representation of census summary data aggregated by group class. - **[ConnectApi.InsuranceUpdateMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_update_member_plans.htm)** Output representation for the member plan update process. - **[ConnectApi.InsuranceAddMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_add_member_plans.htm)** Output representation for adding plans to a member. - **[ConnectApi.InsuranceDeleteMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_delete_member_plans.htm)** Output representation for the member plan deletion process. - **[ConnectApi.InsuranceGetMembersPlans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_get_members_plans.htm)** Output representation for a member's eligible plans. - **[ConnectApi.InsuranceMembersPlansDetailsListRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_members_plans_details_list.htm)** A wrapper for a list of members and their eligible plans. - **[ConnectApi.InsuranceGetMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_get_member_plans.htm)** Output representation of eligible plans for a single member. - **[ConnectApi.InsurancePlanListOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plan_list.htm)** A wrapper for a list of insurance plans. - **[ConnectApi.InsurancePlanOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plan.htm)** Output representation of an insurance plan. - **[ConnectApi.InsurancePlansEligibilityOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plans_eligibility.htm)** Output representation for the employee plan eligibility check. - **[ConnectApi.EligiblePlanDetailsOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_eligible_plan_details.htm)** Output representation containing the details of eligible plans. - **[ConnectApi.InsuranceGroupPlanOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_plan.htm)** Output representation of an insurance group plan. - **[ConnectApi.InsuranceGroupPlanUiTreatmentOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_plan_ui_treatment.htm)** Output representation of a UI treatment returned by the configurator for a plan or coverage. - **[ConnectApi.InsuranceMessageOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_message_output.htm)** Output representation of insurance message. - **[ConnectApi.InsuranceGroupRatingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_rating.htm)** Output representation for the group benefits rating process. - **[ConnectApi.InsuranceIndividualEnrollmentOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_individual_enrollment.htm)** Output representation for the individual enrollment process. - **[ConnectApi.InsuranceIndividualMtaOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_individual_mta_output.htm)** Output representation that's returned after a mid-term adjustment is applied to a group census member's insurance policies. - **[ConnectApi.FamilyPolicyInfoOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_family_policy_info.htm)** Output representation of the policy information for an enrollment or mid-term adjustment. - **[ConnectApi.InsuranceCreateQuoteFromContractOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_create_quote_from_contract_output.htm)** Output representation returned when creating a quote from an existing insurance contract. - **[ConnectApi.MembersWithPlansRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_members_with_plans.htm)** Output representation that's returned when you add or update a family of group census members and their insurance plans. - **[ConnectApi.MemberWithPlansRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_member_with_plans.htm)** Output representation for an individual group census member and the insurance plans that are added or updated for that member. - **[ConnectApi.GroupCensusDeepCloneRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_group_census_deep_clone.htm)** Output representation that's returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[ConnectApi.GroupCensusFieldMappingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_group_census_field_mapping.htm)** Output representation that's returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[ConnectApi.InsuranceGroupEndorsementRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_endorsement.htm)** Output representation that's returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[ConnectApi.InsuranceGroupRenewalRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_renewal.htm)** Output representation that's returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[ConnectApi.InsuranceIssueContractRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_issue_contract.htm)** Output representation that's returned when a group benefits contract is issued synchronously from a quote. - **[ConnectApi.InsuranceContractEndorseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contract_endorse.htm)** Output representation that's returned when an endorsed contract version is created from a quote. - **[ConnectApi.InsuranceContractRenewalRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contract_renewal.htm)** Output representation that's returned when a renewed-term contract is created from a quote. - **[ConnectApi.InsuranceGenerateCensusRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_generate_census.htm)** Output representation that's returned when you start generating a group census from the policies on a group benefits contract. - **[ConnectApi.InsuranceRefreshCensusRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_refresh_census.htm)** Output representation that's returned when you start updating a group census from policy enrollments and endorsements on a group benefits contract. - **[ConnectApi.InsuranceGenerateRefreshCensusMembersRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_generate_refresh_census_members.htm)** Output representation that's returned when you generate or update group census members from policy information on a group benefits contract. # ConnectApi Output Classes Most ConnectApi methods return instances of ConnectApi output classes. All properties are read-only, except for instances of output classes created within test code. All output classes are concrete unless marked abstract in this documentation. All concrete output classes have no-argument constructors that you can invoke only from test code. See [Testing ConnectApi Code](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_TestingApex.htm). Insurance Policy Administration includes these Apex output classes. - **[ConnectApi.CancelPolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_cancel_policy_output.htm)** Output representation details of cancel policy, such as impacted policy versions and refund associated with the cancellation. - **[ConnectApi.ErrorDetailsOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_details_output.htm)** Output representation of the error details, such as error code and error message. - **[ConnectApi.ErrorOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm)** Output representation details of the error encountered while processing the request. - **[ConnectApi.GetPolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_policy_output.htm)** Output representation of the policy details. - **[ConnectApi.OutOfSequenceEndorsePolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_out_of_sequence_endorse_policy.htm)** Output representation for out of sequence endorsement output representation. - **[ConnectApi.PolicyAsyncRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_multi_root_renew_policy_async_output.htm)** Output representation for multi-root policy renewal asynchronous operations. - **[ConnectApi.PolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_policy_output.htm)** Output representation of the policy details. - **[ConnectApi.RefundOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_refund_output.htm)** Output representation of the refund payment. # ConnectApi.AdditionalFieldIARep Input representation for the additional fields. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | key | String | Name of key. | Optional | 63.0 | | value | String | Value for the key. | Optional | 63.0 | # ConnectApi.AdditionalFieldsFieldSetInputRepresentation Input Representation for Additional Fields Field Set | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assetField​SetId | String | ID of the field set to get the fields that are associated with the asset object. | Optional | 65.0 | | coverageField​SetId | String | ID of the field set to get the fields that are associated with the coverage object. | Optional | 65.0 | | participant​FieldSetId | String | ID of the field set to get the fields that are associated with the participant object. | Optional | 65.0 | | policyField​SetId | String | ID of the field set to get the fields that are associated with the policy object. | Optional | 65.0 | # ConnectApi.AdditionalFieldsMapValue AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields​MapValue | Object | Additional fields map containing fields to be updated. | Required | 63.0 | # ConnectApi.AttributeInputRepresentation Input representation for Group Census Member Plan attribute. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeCode | String | Code of the attribute definition to override. | Required if you want to add attributes to a standard or off-contract coverage | 68.0 | | attributeValue | String | Value to apply for the attribute. | Required if attributeCode is specified | 68.0 | # ConnectApi.CalculateAdjustmentsInputRepresentation Input representation for calculating adjustments for claim loss items. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to calculate the adjusted amount for a loss item. | Optional | 67.0 | | benefitName | String | Name of the specific benefit or sub-coverage that's associated with the coverage, as defined in the product attribute mapping. | Optional | 66.0 | | claimedAmount | Double | Amount that's requested by the claimant when submitting the loss. | Required | 65.0 | # ConnectApi.CalculateAdjustmentsRepresentation Output representation of the details for calculating the adjustments for the claim loss item. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | adjustedAmount | Double | Amount after adjustments are made based on the current standings of the policy limits. | 65.0 | | adjustmentReason | String | Reason for the claim coverage payment detail adjustment, such as deductible, copay, or coinsurance. | 65.0 | | claimCovPaymentAdjustments | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimCovPaymentAdjDetailsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_cov_payment_adj_details.htm "Output representation for the claim coverage payment adjustment details.")\> | List of claim coverage payment adjustment details. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | List of errors that are associated with the API request. | 65.0 | | insPolicyLimitTrackings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsPolicyLimitTrackingDetailsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_limit_tracking_details.htm "Output representation for the insurance policy limit tracking details.")\> | List of insurance policy limit tracking details. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | # ConnectApi.CancelClaimCoveragePaymentDetailRep Output representation for the details of the cancel claim coverage payment detail record. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the API request. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail for which the payment is canceled. | 65.0 | # ConnectApi.CancelPolicyInputRepresentation Input representation of the request to cancel a policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the cancellation of the policy goes into effect. | Required | 63.0 | | transactionRecord | [InsurancePolicyTransactionInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm "Input representation details of an insurance policy transaction.") | The JSON structure that overrides the transaction information. | Optional | 63.0 | # ConnectApi.CancelPolicyOutputRepresentation Output representation details of cancel policy, such as impacted policy versions and refund associated with the cancellation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | error | [ConnectApi.ErrorOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm "Output representation details of the error encountered while processing the request.") | List of errors encountered during the processing of the API request. | 63.0 | | impactedPolicyVersions | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of impacted policy versions. | 63.0 | | refund | [ConnectApi.RefundOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_refund_output.htm "Output representation of the refund payment.") | Refund associated with cancellation operation. | 63.0 | # ConnectApi.CheckFinancialAuthorityRep Contains the result of a financial authority check for a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | List of errors, including error codes and messages, that are shown when the user doesn’t have sufficient financial authority to make the payment. | 68.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | 68.0 | | isFinancialAuthorityConfigured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). | 68.0 | | isPaymentAllowed | Boolean | Indicates whether payment is allowed for the evaluated claim coverage payment detail (true) or not (false), based on the User Financial Authority (UFA) record configuration, the user’s financial authority, and the current payment detail status. | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 68.0 | | maximumApprovalAmount | Double | Maximum approval amount for the current user from the matched User Financial Authority (UFA) record. This value is null when no matching UFA record is found. | 68.0 | | requestedBy | String | ID of the user who initiated the payment request. | 68.0 | # ConnectApi.ClaimAdditionalFieldInputRep Input representation for the details of the additional field. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | key | String | API name of key. | Optional | 65.0 | | value | String | Corresponding value for the key. | Optional | 65.0 | # ConnectApi.ClaimAttributeInputRep Invocable action input representation for claim attributes. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API Name of the claim attribute. | Optional | 65.0 | | value | String | Corresponding value for the claim attribute. | Optional | 65.0 | # ConnectApi.ClaimAttributeInputRepresentation Input representation for claim attributes. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the claim attribute. | Optional | 65.0 | | value | String | Value for the claim attribute. | Optional | 65.0 | # ConnectApi.ClaimAttributeOutputRepresentation Output representation for a claim attribute. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | apiName | String | API name of the attribute. | 65.0 | | value | String | Value for the claim attribute. | 65.0 | # ConnectApi.ClaimCoverageRepresentation Output representation for a claim coverage operation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | coverageId | String | ID of the claim coverage record. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the API request. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | warnings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Warning messages that are generated when a claim coverage reserve amount exceeds the reserve amount defined at the claim level. The API operation still completes successfully. The messages identify which reserve limits are exceeded and by how much. | 68.0 | # ConnectApi.ClaimCovPaymentAdjDetailsRep Output representation for the claim coverage payment adjustment details. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | adjustedAmount | Double | Amount deducted from the Posted Amount based on the respective attribute category. | 65.0 | | adjustmentReason | String | Reason for the claim coverage payment adjustment, such as deductible, copay, or coinsurance. | 65.0 | # ConnectApi.ClaimDetailOutputRep Invocable action output representation for claim details. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | accountId | String | ID of the associated account. | 65.0 | | attributes | [ConnectApi.ClaimAttributeOutputs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_attribute_output.htm "Output representation for a claim attribute.") | Attributes of the claim product. | 65.0 | | claimReason | String | Reason for which the claim is raised. | 65.0 | | claimReasonType | String | Type of reason for the claim. | 65.0 | | claimType | String | Type of claim. | 65.0 | | lossType | String | Type of loss for which the claim is initiated. | 65.0 | # ConnectApi.ClaimInputRepresentation Input representation for creating or updating a claim. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the account that's associated with the claim. | Optional | 65.0 | | additionalFields | Object | Additional fields for the claim. | Optional | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute.htm "Input representation for claim attributes.")\> | List of attributes for the claim product. | Optional | 65.0 | | claimLossDate | String | Date when the loss occurred. This parameter doesn't accept time of incident. To specify both the date and time of loss, use the lossDate parameter. | Optional | 66.0 | | claimReason | String | Reason for the claim. | Optional | 65.0 | | claimReasonType | String | Type of reason for the claim. | Optional | 65.0 | | claimType | String | Type of claim. | Optional | 65.0 | | expenseReserveAdjustmentReason | String | Reason for the expense reserve adjustment. | Optional | 68.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 68.0 | | insurancePolicyId | String | ID of the insurance policy on which the claim is raised. | Optional | 65.0 | | items | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item.htm "Input representation for claim items.")\> | Claim items that are associated with the claim. | Optional | 65.0 | | lossDate | Date | Date on which the loss occurred. | Optional | 65.0 | | lossReserveAdjustmentReason | String | Reason for the loss reserve adjustment. | Optional | 68.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 68.0 | | lossType | String | Type of loss for which the claim is raised. | Optional | 65.0 | | name | String | Name of the claim. | Optional | 65.0 | | options | [ConnectApi.ClaimOptionsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_options.htm "Input representation for claim options.") | Options to include during the claim creation or update process. | Optional | 65.0 | | participants | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimParticipantInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_participant.htm "Input representation for a claim participant.")\> | Participants who are associated with the claim. | Optional | 65.0 | | productCode | String | Product code of the claim product. | Optional | 65.0 | # ConnectApi.ClaimItemInputRep Invocable action input representation for claim item. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | action | String | Action to perform on the record, such as add, update, or delete. | Optional | 65.0 | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm "Input representation for the details of the additional field.")\> | Additional fields for the claim item. | Optional | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute_input_re.htm "Invocable action input representation for claim attributes.")\> | Attributes that are assigned to claim item. | Optional | 65.0 | | category | String | Category of claim item. | Optional | 65.0 | | instanceKey | String | Unique identifier for claim item. | Optional | 65.0 | | insurancePolicyCoverageId | String | ID of the insurance policy coverage that applies to the claim item. | Optional | 65.0 | | insuredItemId | String | ID of the insured item that's involved in the claim. | Optional | 65.0 | | name | String | Name of the claim item. | Optional | 65.0 | | participantInstanceKey | String | Unique identifier that's used to link a claim item to a specific participant. | Optional | 65.0 | | productCode | String | Product code of the claim item product. | Optional | 65.0 | | relatedObjects | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemRelatedObjectInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item_related_object_input_re.htm "Invocable action input representation for the related object in claim items.")\> | Related claim item records. | Optional | 65.0 | # ConnectApi.ClaimItemInputRepresentation Input representation for claim items. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | action | String | Action to perform on the record, such as create or update. | Optional | 65.0 | | additionalFields | Object | Additional standard or custom fields for the claim item. | Optional | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute.htm "Input representation for claim attributes.")\> | Attributes of the claim item. | Optional | 65.0 | | category | String | Category of the claim item. | Optional | 65.0 | | instanceKey | String | Unique identifier of the claim item. | Optional | 65.0 | | insurancePolicy​CoverageId | String | ID of the insurance policy coverage that applies to the claim item. | Optional | 65.0 | | insuredItemId | String | ID of the insured item that's involved in the claim. | Optional | 65.0 | | name | String | Name of the claim item. | Optional | 65.0 | | participantInstanceKey | String | Unique identifier that's used to link a claim item to a specific participant. | Optional | 65.0 | | productCode | String | Product code of the claim item product. | Optional | 65.0 | | relatedObjects | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimRelatedObjectInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_related_object.htm "Input representation for a related object on a claim.")\> | Related claim item records. | Optional | 65.0 | # ConnectApi.ClaimItemOutputRep Invocable action output representation for claim item. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | category | String | Category of the claim item. | 65.0 | | claimItemDetails | [ConnectApi.ClaimItemDetailOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_detail_output_re.htm "Invocable action output representation for claim details.") | Details of the claim items. | 65.0 | | id | String | ID of the claim item. | 65.0 | | instanceKey | String | Unique instance key of the claim item. | 65.0 | | insuredItemId | String | ID of the insured item involved. | 65.0 | | name | String | Name of the claim item. | 65.0 | | productCode | String | Product code of the claim item. | 65.0 | # ConnectApi.ClaimItemOutputRepresentation Output representation for a claim item. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | additionalFields | Object | Additional fields of the claim item. | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_attribute_output.htm "Output representation for a claim attribute.")\> | Attributes of the claim item. | 65.0 | | category | String | Category of the claim item. | 65.0 | | id | String | ID of the claim item. | 65.0 | | instanceKey | String | Unique instance key of the claim item. | 65.0 | | insurancePolicyCoverageId | String | ID of the insurance policy coverage. | 65.0 | | insuredItemId | String | ID of the insured item involved. | 65.0 | | name | String | Name of the claim item. | 65.0 | | participantInstanceKey | String | Instance key of the claim participant. | 65.0 | | productCode | String | Product code of the claim item. | 65.0 | | relatedObjects | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimRelatedObjectOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_related_object_output.htm "Output representation for a related object.")\> | Claim item related objects. | 65.0 | # ConnectApi.ClaimItemOutputs Invocable action output representation for a wrapper that contains a list of claim items. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimItems | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_output_re.htm "Invocable action output representation for claim item.")\> | List of claim items. | 65.0 | # ConnectApi.ClaimItemRelatedObjectInputRep Invocable action input representation for the related object in claim items. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordId | String | ID of the related claim item record. | Optional | 65.0 | | recordObjName | String | Object name of the related claim item record. | Optional | 65.0 | # ConnectApi.ClaimOptionInputRep Invocable action input representation for claim options | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | executeConfigurationRules | String | Specifies whether to execute configuration rules or not. | Optional | 65.0 | # ConnectApi.ClaimOptionsInputRepresentation Input representation for claim options. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | execute​Configuration​Rules | String | Specifies whether to execute configuration rules or not. | Optional | 65.0 | # ConnectApi.ClaimOutputRepresentation Output representation for a retrieved claim. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | accountId | String | ID of the associated account. | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_attribute_output.htm "Output representation for a claim attribute.")\> | Attributes of the claim product. | 65.0 | | claimId | String | ID of the claim. | 65.0 | | claimLossDate | String | Date when the loss occurred. This parameter doesn't show the time of incident. | 66.0 | | claimReason | String | Reason for which the claim is raised. | 65.0 | | claimReasonType | String | Type of reason for the claim. | 65.0 | | claimType | String | Type of claim. | 65.0 | | contextId | String | ID of the context. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Errors that are encountered during the processing of the API request. | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | 68.0 | | insurancePolicyId | String | ID of the insurance policy on which the claim is raised. | 65.0 | | items | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_output.htm "Output representation for a claim item.")\> | Details of the claim items. | 65.0 | | lossDate | Date | Date on which the incident took place. | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | 68.0 | | lossType | String | Type of loss for which the claim is initiated. | 65.0 | | name | String | Name of the claim. | 65.0 | | participants | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimParticipantOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_output.htm "Output representation for a claim participant.")\> | Details of the claim participants. | 65.0 | | productCode | String | Product code of the claim product. | 65.0 | # ConnectApi.ClaimParticipantInputRep Invocable Action Input representation for Claim Participant | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Account ID that's associated with the claim participant. | Optional | 65.0 | | action | String | Action to perform on the record, such as create or update. | Optional | 65.0 | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm "Input representation for the details of the additional field.")\> | Additional standard or custom fields to add details for the claim participant. | Optional | 65.0 | | contactId | String | Contact ID that's associated with the participant. | Optional | 65.0 | | instanceKey | String | Unique identifier for the participant. | Optional | 65.0 | | insurancePolicyParticipantId | String | ID of the insurance policy participant that's related to the claim. | Optional | 65.0 | | isInjured | String | Specifies if the participant is injured or not. | Optional | 65.0 | | roles | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Roles of the claim participant. | Optional | 65.0 | # ConnectApi.ClaimParticipantInputRepresentation Input representation for a claim participant. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Account ID of the claim participant. | Optional | 65.0 | | action | String | Action to perform on the record, such as create or update. | Optional | 65.0 | | additionalFields | Object | Additional fields for the claim record to create or update the record. | Optional | 65.0 | | contactId | String | Contact ID of the claim participant. | Optional | 65.0 | | instanceKey | String | Unique instance key of the claim participant. | Optional | 65.0 | | insurancePolicyParticipantId | String | ID of the insurance policy participant that's related to the claim. | Optional | 65.0 | | isInjured | String | Specifies if the participant is injured or not. | Optional | 65.0 | | roles | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Roles of the claim participant. | Optional | 65.0 | # ConnectApi.ClaimParticipantOutputRep Invocable action output representation for claim participant. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | accountId | String | Account ID of the claim participant. | 65.0 | | contactId | String | Contact ID of the claim participant. | 65.0 | | id | String | ID of the claim participant. | 65.0 | | instanceKey | String | Instance key of the claim participant. | 65.0 | | insurancePolicyParticipantId | String | Insurance policy participant ID of the claim participant. | 65.0 | | roles | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Roles of the claim. | 65.0 | # ConnectApi.ClaimParticipantOutputRepresentation Output representation for a claim participant. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | accountId | String | Account ID of the claim participant. | 65.0 | | contactId | String | Contact ID of the claim participant. | 65.0 | | id | String | ID of the claim participant. | 65.0 | | instanceKey | String | Instance key of the claim participant. | 65.0 | | insurancePolicyParticipantId | String | Insurance policy participant ID of the claim participant. | 65.0 | | roles | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Claim participant roles. | 65.0 | # ConnectApi.ClaimParticipantOutputs Invocable action output representation for a wrapper that contains a list of claim participants. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimParticipants | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimParticipantOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_output_re.htm "Invocable action output representation for claim participant.")\> | List of claim participants. | 65.0 | # ConnectApi.ClaimRelatedObjectInputRepresentation Input representation for a related object on a claim. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordId | String | ID of the related claim item record. | Optional | 65.0 | | recordObjName | String | Object name of the related claim item record. | Optional | 65.0 | # ConnectApi.ClaimRelatedObjectOutputRepresentation Output representation for a related object. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | relatedRecordId | String | ID of the related object. | 65.0 | | relatedRecordObjName | String | API name of the related object. | 65.0 | # ConnectApi.ContractItem Addition fields to be added to the contract items. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | API name of the entity to add fields to, such as ContractGroupPlan. | Optional | 65.0 | | fields | List<[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm "Input representation for the Apex enabled string.")\> | List of key-value pairs that represent the fields and their values for the entity. | Optional | 65.0 | | instanceKey | String | Unique instance key of the Quote Line Item. | Optional | 65.0 | # ConnectApi.CreateClaimCoverageInputRepresentation Input representation for creating a claim coverage. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Object | Additional fields for the claim coverage. | Optional | 65.0 | | claimItemId | String | ID of the claim item. | Optional | 65.0 | | claimParticipantId | String | ID of the claim participant. | Optional | 65.0 | | currencyIsoCode | String | Currency ISO code for reserve adjustments. | Optional | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | insurancePolicyAssetId | String | ID of the insurance policy asset. | Optional | 65.0 | | insurancePolicyCoverageId | String | ID of the insurance policy coverage. | Optional | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | | name | String | Name of the claim coverage. | Optional | 65.0 | | reserveProcessingMode | String | Determines how financial reserves are handled when a claim coverage is created. | Optional | 65.0 | # ConnectApi.CreateClaimCoveragePaymentDetailRep Output representation for the details of the create claim coverage payment detail record. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | adjustedAmount | Double | Adjusted amount of the claim coverage payment detail. | 65.0 | | adjustedReason | String | Reason for the adjustment. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | List of errors, including detailed information about each error. | 65.0 | | insurancePolicyLimitTrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the insurance policy limit tracking records. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or (not). | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record that's created. | 65.0 | # ConnectApi.CreateClaimCovPaymentDetailInputRep Input representation for creating a claim coverage payment detail record. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Object | Additional standard or custom fields that are used to create the claim coverage payment detail record. | Optional | 65.0 | | adjustedAmount | Double | Amount deducted from the Posted Amount based on the respective attribute category. | Optional | 65.0 | | benefitName | String | Sub-coverage information. | Optional | 65.0 | | claimedAmount | Double | Amount of the claim. | Optional | 65.0 | | coveragePaymentType | String | Specifies the category of the payment. The value must be either Loss or Expense. Loss refers to the payment related to the policyholder's covered damages. Expense refers to costs associated with claim processing, such as vendor fees. | Optional | 65.0 | | description | String | Description of the payment detail. | Optional | 65.0 | | limitUnitCount | Integer | Number of units for this claim coverage payment detail, such as the number of days for a rental car expense. The default value is 1. | Optional | 65.0 | | recipientId | String | ID of the recipient. | Optional | 65.0 | # ConnectApi.CreateClaimInputRepresentation Input representation for the Create Claim action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the account that's associated with the claim. | Optional | 65.0 | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm "Input representation for the details of the additional field.")\> | Additional standard or custom fields that are used to create or update insurance claim. | Optional | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute_input_re.htm "Invocable action input representation for claim attributes.")\> | Attributes of the claim product. | Optional | 65.0 | | claimReason | String | Reason for the claim. | Optional | 65.0 | | claimReasonType | String | Category that the claim reason belongs to. | Optional | 65.0 | | claimType | String | Type of claim. | Optional | 65.0 | | expenseReserveAdjustmentReason | String | Reason for the expense reserve adjustment. | Optional | 68.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 68.0 | | insurancePolicyId | String | ID of the insurance policy on which the claim is raised. | Optional | 65.0 | | items | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item_input_re.htm "Invocable action input representation for claim item.")\> | Details of the items that are associated with the claim. | Optional | 65.0 | | lossDate | String | Date on which the loss occurred. | Optional | 65.0 | | lossReserveAdjustmentReason | String | Reason for the loss reserve adjustment. | Optional | 68.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 68.0 | | lossType | String | Type of the loss for which the claim is initiated. | Optional | 65.0 | | name | String | Name of the claim. | Optional | 65.0 | | options | [ClaimOptionsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_options_input_re.htm "Invocable action input representation for claim options") | Options for creating or updating a claim. | Optional | 65.0 | | participants | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimParticipantInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_participant_input_re.htm "Invocable Action Input representation for Claim Participant")\> | Claim participants that are associated with the claim. | Optional | 65.0 | | productCode | String | Product code of the claim product. | Required to create a claim | 65.0 | # ConnectApi.CreateClaimOutputRepresentation Output representation for a create or update claim operation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimId | String | ID of the created or updated claim. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the API request. | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | 65.0 | # ConnectApi.CreatePolicyLimitsInputRep Input representation for the apex ConnectApi.CreatePolicyLimitsInputRep record that contains the details of the policy limits to be created. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeScopes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Attribute scopes for which policy limit records must be created. | Optional | 65.0 | | policyId | String | ID of the insurance policy for which the limits must be generated. | Required | 65.0 | # ConnectApi.CreatePolicyLimitsInputRepresentation Input representation for creating insurance policy limit records. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeScopes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of attribute scopes for which the policy limit records must be created. | Optional | 65.0 | # ConnectApi.CreatePolicyLimitsRepresentation Output representation of the created insurance policy limit records. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Errors that are encountered during the processing of the API request. | 65.0 | | policyLimitIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs for the insurance policy limit records that are created. | 65.0 | # ConnectApi.DeleteClaimCoveragePaymentDetailRep Output representation for the Delete Claim Coverage Payment Detail resource. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the API request. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | 65.0 | # ConnectApi.DeleteClaimCvrPymtDtlInputRep Input representation for deleting claim coverage payment detail operations | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim whose coverage payment detail must be deleted. | Required | 65.0 | | coverageId | String | ID of the claim coverage record. | Required | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | Required | 65.0 | # ConnectApi.EditClaimCoveragePaymentDetailRep Output representation for editing claim coverage payment detail. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | adjustedAmount | Double | Final amount after all deductions, such as deductibles or co-pays. This field is returned when a Loss item is created and adjustments are applied. | 65.0 | | adjustedReason | String | Reason for the claim coverage payment detail adjustment, such as deductible, copay, or coinsurance. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | List of errors, including detailed information about each error when the API operation fails. | 65.0 | | insurance​PolicyLimit​TrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Comma-separated IDs of the insurance policy limit tracking records. | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | 65.0 | # ConnectApi.EditClaimCvrPaymentDetailInputRep Input representation for editing claim coverage payment detail.
Property Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields that are used to update the claim coverage payment detail record. Optional 66.0
adjustedAmount Double Amount deducted from the Posted Amount based on the respective attribute category. Optional 66.0
claimedAmount Double Amount of the claim. Optional 66.0
description String Description of the payment detail. Optional 66.0
limitUnitCount Integer Number of units for this claim coverage payment detail, such as the number of days for a rental car expense. The default value is 1. Optional 66.0
name String Name of the claim coverage payment detail record. Optional 66.0
recipientId String ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor.

For a Loss item, the recipient is the policyholder or a third party. For an Expense item, the recipient ID represents a vendor or internal staff member.

 Optional 66.0
status String Current status of the claim coverage payment detail. Optional 66.0
# ConnectApi.EligiblePlanDetailsOutputRepresentation Output representation containing the details of eligible plans. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | messages | List<[ConnectApi.InsuranceMessageOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_message_output.htm "Output representation of insurance message.")\> | List of informational or warning messages related to the eligibility results. | 65.0 | | plans | List<[ConnectApi.InsuranceGroupPlanOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_plan.htm "Output representation of an insurance group plan.")\> | List of the contract group plans that the member is eligible for. | 65.0 | # ConnectApi.EndorsePolicyInputRepresentation Input representation of the request to endorse a policy. Context ID of the quote that’s used for endorsement and date that the endorsed policy version is effective from must be passed in the request. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.Additional​FieldsMapValue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_map_valu.htm "AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap.")\> | The JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [InsurancePolicyBillingInfo​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_billing_info.htm "Input representation for insurance policy billing.") | Details of insurance policy billing. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the quote that’s used for endorsement. | Required | 63.0 | | effectiveDate | String | Date from when endorsed policy version is effective from. | Required | 63.0 | | insurancePolicy | [InsurancePolicyInput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm "Input representation details of an insurance policy transaction.") | The JSON structure that overrides the name and policy number of the endorsed policy version. | Optional | 63.0 | | transactionRecord | [InsurancePolicy​Transaction​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm "Input representation details of an insurance policy transaction.") | The JSON structure that overrides the transaction information. | Optional | 63.0 | # ConnectApi.ErrorDetail Output representation of an error. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | code | String | Code of the error. | 65.0 | | message | String | Message of the error. | 65.0 | # ConnectApi.ErrorDetailsOutputRepresentation Output representation of the error details, such as error code and error message. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | code | String | The error code thrown when the request fails. | 63.0 | | message | String | Message stating the reason for error, if any. | 63.0 | # ConnectApi.ErrorOutputRepresentation Output representation details of the error encountered while processing the request. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | detail | String | Description of the error. | 63.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.Error​DetailsOutput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_details_output.htm "Output representation of the error details, such as error code and error message.")\> | Output representation of the error details. | 63.0 | | instance | String | Instance where the error occurred. | 63.0 | | title | String | Short label of the error type. | 63.0 | # ConnectApi.FamilyPolicyInfoOutputRepresentation Output representation of the policy information for an enrollment or mid-term adjustment. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | plan | String | Name of the plan that's associated with the policy. | 65.0 | | policy | String | ID of the insurance policy that's created or updated. | 65.0 | # ConnectApi.FieldSetIDsInputRep List of the field set IDs for asset, coverage, participant, and policy objects. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | asset​FieldSetId | String | ID of the field set to get the fields associated with the asset object. | Optional | 64.0 | | coverage​FieldSetId | String | ID of the field set to get the fields associated with the coverage object. | Optional | 64.0 | | participant​FieldSetId | String | ID of the field set to get the fields associated with the participant object. | Optional | 64.0 | | policy​FieldSetId | String | ID of the field set to get the fields associated with the policy object. | Optional | 64.0 | # ConnectApi.GetClaimInputRepresentation Input representation to get the details of a claim. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim to get the details for. | Required | 65.0 | # ConnectApi.GetClaimOutputRepresentation Output representation for the Get Claim action. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimDetails | [ConnectApi.ClaimDetailOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_detail_output_re.htm "Invocable action output representation for claim details.") | Details of the claim. | 65.0 | | claimId | String | ID of the claim. | 65.0 | | contextId | String | ID of the context that's associated with the claim. | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | 68.0 | | insurancePolicyId | String | ID of the insurance policy on which the claim is raised. | 65.0 | | lossDate | String | Date on which the incident took place. | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | 68.0 | | name | String | Name of the claim. | 65.0 | | productCode | String | Product code of the claim product. | 65.0 | # ConnectApi.GetInsPlcyCurrStndInputRep An Apex ConnectApi.GetInsPlcyLmtCurrStndInputRep record that contains the details needed to retrieve the consumed and available limits for the policy or claim. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimCoverageId | String | ID of the claim coverage record. | Optional | 65.0 | | claimId | String | ID of the claim for which you want to get the current standings. | Required to get the standings for a claim. | 65.0 | | options | [ConnectApi.IPLStandingCalcOptions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_i_p_l_standing_calc_option.htm "Invocable action input representation for options to calculate standings.") | Options to include pending values and filter coverage. | Optional | 65.0 | | policyAssetId | String | ID of the insurance policy asset. | Optional | 65.0 | | policyCoverageId | String | ID of the policy coverage record. | Optional | 65.0 | | policyId | String | ID of the insurance policy for which you want to get the current standings. | Required to get the standings for a policy. | 65.0 | | policyParticipantId | String | ID of the policy participant. | Optional | 65.0 | # ConnectApi.GetInsPlcyCurrStndOutputRep An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy or claim. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | iplStandingCalcOutputNodes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.IPLStandingCalcOutputNode](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_output_node.htm "Node representation for the Insurance Policy Term Current Standing invocable action node.")\> | List of policy limit current standing nodes. | 65.0 | # ConnectApi.GetPolicyOutputRepresentation Output representation of the policy details. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contextId | String | ID of the context. | 63.0 | | error | [ConnectApi.ErrorOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm "Output representation details of the error encountered while processing the request.") | List of errors encountered during the processing of the API request. | 63.0 | | insurancePolicy | [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_map.htm "HTML (New Window)") | Details of insurance policy. | 63.0 | # ConnectApi.GroupbenefitsAttributeInputRepresentation Input representation for an attribute value that overrides the value derived from the product on a group census member plan. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeCode | String | Code of the product attribute whose value you want to override for the member plan. | Optional | 68.0 | | attributeValue | String | Value to apply to the attribute instead of the value that's derived from the product. | Optional | 68.0 | # ConnectApi.GroupCensusDeepCloneInputRepresentation Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextDefId | String | API name of the custom context definition that overrides the standard group census deep-clone context definition. Use this property when you need unique fields or specialized mappings that the standard context definition doesn't include. | Optional | 68.0 | | groupCensusFilters | [ConnectApi.GroupCensusFilters​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_filters.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that limit which records in the source census hierarchy are cloned. For example, clone only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [ConnectApi.GroupCensusReference​MappingsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_reference_mappings.htm "Input representation of the per-entity reference values stamped on group census member plan records.") | Reference mappings to apply on the cloned records. Use these mappings to associate source references with target references, such as mapping quote line items to contract group plans. | Optional | 68.0 | | targetGroupCensusOverrides | [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_map.htm "HTML (New Window)") | Map of field API names and values to apply to the cloned GroupCensus record. Use this map to set new values on the target census, such as the census name or description. | Optional | 68.0 | # ConnectApi.GroupCensusDeepCloneRepresentation Output representation that's returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | List of errors that occurred while validating the request or scheduling the asynchronous deep-clone job. An empty list indicates that the job was scheduled successfully. | 68.0 | | requestId | String | ID of the asynchronous deep-clone request. Use this ID to track the status and results of the job. | 68.0 | # ConnectApi.GroupCensusFieldMappingInputRepresentation Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusFilters | [ConnectApi.GroupCensusFilters​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_filters.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that identify which records of the existing group census are processed. For example, process only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [ConnectApi.GroupCensusReference​MappingsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_reference_mappings.htm "Input representation of the per-entity reference values stamped on group census member plan records.") | Reference mapping rules that update group census records from a quote to a contract or from a contract to a quote. For example, remap quote line item references to contract group plans after a quote is converted to a contract. | Optional | 68.0 | # ConnectApi.GroupCensusFieldMappingRepresentation Output representation that's returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | List of errors that occurred while validating the request or scheduling the asynchronous field-mapping job. An empty list indicates that the job was scheduled successfully. | 68.0 | | requestId | String | ID of the asynchronous bulk request. Use this ID to track the status and results of the field-mapping job. | 68.0 | # ConnectApi.GroupCensusFiltersInputRepresentation Input representation of the per-entity filters that scope which group census member plan records are processed. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberPlanFilter | [ConnectApi.MemberPlanFilter​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan_filter.htm "Input representation of the filter that identifies which group census member plan records to process.") | Filter that identifies the group census member plan records to process for a specific group benefits quote or contract. | Optional | 68.0 | # ConnectApi.GroupCensusMemberInputRepresentation Input representation for a group census member. This class contains properties for all the fields on the Group Census Member object. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Person account ID. | Optional | 65.0 | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.AdditionalFieldsMapValue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_map_valu.htm "AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap.")\> | List of key-value pairs for populating custom fields or other fields. | Optional | 65.0 | | annualEligibleSalary | Double | Annual salary that's eligible for benefits calculations. | Optional | 65.0 | | associationWithPrimaryMbr | String | Association to primary member for dependents, such as Spouse, Child. | Optional | 65.0 | | birthdate | String | Member's date of birth in YYYY-MM-DD format. | Optional | 65.0 | | city | String | City of the member's address. | Optional | 65.0 | | contactId | String | ID of the Contact record of the member. | Optional | 65.0 | | country | String | Country of the member's address. | Optional | 65.0 | | dependentCount | Integer | Number of dependents that are associated with the member. | Optional | 65.0 | | email | String | Email address of the member. | Optional | 65.0 | | firstName | String | First name of the member. | Required to add a member | 65.0 | | fullTimeEquivalent | Double | Work capacity of the member, where 1.0 indicates a full-time employee. | Optional | 65.0 | | gender | String | Gender of the member. | Optional | 65.0 | | groupCensusId | String | ID of the Group Census that the member belongs to. | Optional | 65.0 | | groupClassId | String | ID for the specific class or category within the group that the member belongs to. | Optional | 65.0 | | groupClassName | String | Name of the group class. | Optional | 65.0 | | grpCensusGrpClassSummaryId | String | ID of the related group census group class summary record. | Optional | 65.0 | | id | String | ID of the group census member. | Required to update member details | 65.0 | | isOptOutAllPlans | Boolean | Indicates whether the member has opted out of all available insurance plans (true) or not (false). | Optional | 65.0 | | isPortalUser | Boolean | Indicates whether a community portal user must be created for this member (true) or not (false). | Optional | 65.0 | | joinDate | String | Date the member joined the group or company. | Optional | 65.0 | | lastname | String | Last name of the member. | Required to add member | 65.0 | | memberKey | String | Unique, externally defined key that's used for identifying and preventing duplicate members, often created by concatenating several fields. | Optional | 65.0 | | memberType | String | Type of member, such as Primary or Dependent. | Optional | 65.0 | | name | String | Full name of the member. | Optional | 65.0 | | optOutPlanTypes | String | Types of plans the member has opted out of. | Optional | 65.0 | | phoneNumber | String | Phone number of the member. | Optional | 65.0 | | policyStartDate | String | Date when the member's policy coverage begins. | Optional | 65.0 | | postalCode | String | Postal or ZIP code of the member's address. | Optional | 65.0 | | primaryGroupCensusMemberId | String | ID of the primary group census member the dependents are associated with. | Optional | 65.0 | | primaryMemberCategory | String | Category of the primary member. | Optional | 65.0 | | primaryMemberSource | String | System or source from which the member's data originated. | Optional | 65.0 | | relationshipToPrimaryMember | String | Member's relationship to the primary insured. | Optional | 65.0 | | smokerStatus | String | Smoking status of the member, such as Smoker or Non-smoker. | Optional | 65.0 | | sourceSystemIdentifier | String | ID from an external source system, that's used for integration purposes. | Optional | 65.0 | | state | String | State or province the member belongs to. | Optional | 65.0 | | status | String | Current status of the member. | Optional | 65.0 | | street | String | Street address of the member. | Optional | 65.0 | # ConnectApi.GroupCensusMemberPlanInputRepresentation Input representation for a single plan that's associated with a group census member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | List<[ConnectApi.AttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_attribute.htm "Input representation for Group Census Member Plan attribute.")\> | List of attribute-level changes that you want to make for the specific off-contract plan or coverage. Use this parameter to define custom values for individual plan attributes, such as deductibles, co-pays, or waiting periods, that differ from the base Product2 definition. | Optional | 68.0 | | contractGroupPlanId | String | ID of the contract group plan. | Required | 65.0 | | groupCensusMemberId | String | ID of the group census member. | Optional | 65.0 | | id | String | ID of the group census member plan record. | Required to update plan | 65.0 | | name | String | Name of the group census member plan. | Optional | 65.0 | | productCode | String | Product code of the Product2 record for the off-contract coverage overrides. Use this parameter to add a coverage that doesn’t exist in the member’s assigned contract group plan. | Required if contractGroupPlanId isn’t specified | 68.0 | | rootProductCode | String | Product code of the root product to which the off-contract coverage (defined by productCode) belongs. | Required if productCode is specified | 68.0 | # ConnectApi.GroupCensusReferenceMappingsInputRepresentation Input representation of the per-entity reference values stamped on group census member plan records. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberPlanReferenceMapping | [ConnectApi.MemberPlanReference​MappingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan_reference_mapping.htm "Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse.") | Reference mapping for group census member plan records. Use this mapping to associate source record references with corresponding target record references, for example from a quote to a contract or from a contract to a quote. | Optional | 68.0 | # ConnectApi.InsAttributeInputRepresentation Input representation of one attribute definition to validate. Provide at least one of attribute ID, attribute code, or developer name. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeCode | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Code of the attribute definition. The method uses this value when the attribute ID doesn't resolve to an AttributeDefinition record. | Required if attributeId and attributeName aren't specified | 68.0 | | attributeId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the attribute definition. The method resolves lookups by attribute ID first. | Required if attributeCode and attributeName aren't specified | 68.0 | | attributeName | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Developer name of the attribute definition. The method uses this value when the attribute ID and attribute code don't resolve to an AttributeDefinition record. For a dynamic context attribute, when you also specify a context definition ID, send the attribute's dictionary name as configured in Setup. | Required if attributeId and attributeCode aren't specified | 68.0 | # ConnectApi.InsAttributeValidationInputRepresentation Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeLookups | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsAttribute​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_attribute.htm "Input representation of one attribute definition to validate. Provide at least one of attribute ID, attribute code, or developer name.")\> | Attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name. The method confirms that each definition exists in the org and is active. | Required | 68.0 | | contextDefinitionId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the context definition. When you specify this ID, dynamic context attributes, such as attributes whose names start with DYN\_\_INS\_\_, are resolved against that context definition's dynamic-attributes catalog before the method looks up AttributeDefinition records. | Optional | 68.0 | # ConnectApi.InsAttributeValidationRepresentation Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn't. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsAttribute​Validation​Result​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_attribute_validation_result.htm "Output representation of the validation result for one attribute lookup. The result includes the identifiers from the request and includes resolution guidance when the attribute definition can't be validated.")\> | Validation result for each attribute lookup. Each result includes the identifiers from the request and reports whether that attribute definition is valid or not. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | List of errors that are encountered while validating the attribute definitions. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether every attribute lookup is valid (true) or not (false). This value is true when every per-attribute result is valid, and false when any result is invalid. | 68.0 | # ConnectApi.InsAttributeValidationResultRepresentation Output representation of the validation result for one attribute lookup. The result includes the identifiers from the request and includes resolution guidance when the attribute definition can't be validated. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributeCode | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Attribute code. | 68.0 | | attributeId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Attribute ID. | 68.0 | | attributeName | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Developer name of the attribute definition. | 68.0 | | instructions | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Details​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm "Output representation of the validation error of an attribute with the code and message.")\> | Resolution guidance for this attribute when the attribute is invalid. Each entry includes an error code and a message. Empty or not returned when the attribute is valid. Per-attribute failures use SF-INS-DSAV-00030 when the attribute definition isn't found, SF-INS-DSAV-00031 when it is inactive, and SF-INS-DSAV-00032 when the lookup doesn't include an attribute ID, code, or developer name. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether this attribute definition exists and is active (true) or not (false). | 68.0 | # ConnectApi.InsCMLModelValidationInputRepresentation Input representation of the insurance products and related records to validate against the active CML model. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauseIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)")\> | List of insurance product clause IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | | productIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)")\> | List of root product IDs to be validated. For each ID, the method verifies that the product has an active CML model associated with it. | Required | 68.0 | | productSurchargeIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)")\> | List of product surcharge IDs to validate against the active CML model that’s identified by productIds. For each surcharge, the method checks whether the record exists, and whether every segment of its ProductPath is referenced by the active CML association. Don’t specify this property if you don’t want to validate surcharges for the products. | Optional | 68.0 | | underwritingRuleIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)")\> | List of underwriting rule IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | # ConnectApi.InsCMLModelValidationRepresentation Output representation of the per-record validation results and any top-level errors that occur when processing the request. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | Request-level errors that occurred before per-record validation runs. This property doesn’t contain per-record validation failures. Those appear inside results with isValid set to false. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether the CML model validation passed for every record (true) or not (false). This value is true when every per-record result is valid, and false when any result is invalid. | 68.0 | | results | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsCML​Model​Validation​Result​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_cml_model_validation_result.htm "Output representation of the validation result for a single record. When the record isn’t valid, instructions describes the failure and recommended correction.")\> | Validation results for each specified record. This property contains one entry for every specified record across productIds, productSurchargeIds, productClauseIds, and underwritingRuleIds. It shows an empty list on a request-level error. | 68.0 | # ConnectApi.InsCMLModelValidationResultRepresentation Output representation of the validation result for a single record. When the record isn’t valid, instructions describes the failure and recommended correction. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | instructions | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Human-readable resolution guidance that describes the reason for a validation failure and how to resolve it. This property contains details when isValid is false. For valid results, this property is either null or contains informational context, such as when a BRE-based underwriting rule has no CML rule key. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether this record passed validation (true) or not (false). When false, see instructions for the failure reason and correction. | 68.0 | | productPath | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ProductPath field value from the validated record. This property is returned only when recordType is ProductSurcharge or InsuranceProductClause. | 68.0 | | recordId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the record that’s validated. | 68.0 | | recordType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Type of record. Valid values are Product, ProductSurcharge, InsuranceProductClause, and UnderwritingRule. | 68.0 | # ConnectApi.InsDesignAdvisorErrorDetailsOutputRepresentation Output representation of the validation error of an attribute with the code and message. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | code | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Code of the validation error. | 68.0 | | message | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Message that describes the validation error. | 68.0 | # ConnectApi.InsDesignAdvisorErrorResponseRepresentation Output representation of an error returned by an Insurance Design Advisor validation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | code | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Code that identifies the error. | 68.0 | | message | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Message that describes the error. | 68.0 | # ConnectApi.InsGBQuoteConfigOptions Input representation for configuration options when creating an insurance group benefits quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | executeConfigurationRules | Boolean | Specifies whether to run configuration rules as part of insurance quote processing (true) or not (false). | Optional | 67.0 | | executeQualificationRules | Boolean | Specifies whether to run qualification rules as part of insurance quote processing (true) or not (false). | Optional | 67.0 | # ConnectApi.InsGetRatingInputInputRepresentation Input representation that specifies the product for which to generate a sample rating input payload. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the product for which you want to generate a sample rating API request. Must be a valid 15- or 18-character Salesforce ID. | Required | 68.0 | # ConnectApi.InsGetRatingInputRepresentation Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | additionalDetails | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Advisory note about using the sample payload. For example, the sample can omit transactionType, which you must supply (a TransactionProcessingType developer name configured in the org) before you send the payload to the rating API; otherwise the quote-level pricing procedure doesn’t resolve. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | List of errors encountered during rating input generation. Empty or null when the operation has no error. Each item provides an error code and a message. | 68.0 | | ratingInput | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Serialized JSON string containing a complete sample rating request body to use with the insurance/product-rating API. The JSON string includes product hierarchy, product codes, instance keys, and attribute codes with sample values. Parse this string before you submit it to the rating API, and replace sample values with real data. | 68.0 | # ConnectApi.InsLookupErrorCodeInputRepresentation Input representation that specifies the insurance error code to look up. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | errorCode | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | The unique alphanumeric insurance error code identifier to look up. Must follow the SF-INS-XXX-NNNNN format, for example, SF-INS-DSAV-00023 and SF-INS-COM-00009. | Required | 68.0 | # ConnectApi.InsLookupErrorCodeRepresentation Output representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errorCause | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Detailed explanation of the underlying business logic or validation rule that triggered this error. This property is omitted if a cause is unavailable or null. | 68.0 | | errorCode | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Error code that’s looked up. | 68.0 | | errorDescription | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Human-readable description of the error. For known error codes, this is the registered description. It shows an informative “not found” message if the error code is unrecognized. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | List of request-level validation or processing errors encountered before executing business logic. Present when the request fails basic validation (such as a missing or blank errorCode). Empty or null on a successful lookup. | 68.0 | | instructions | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Step-by-step troubleshooting guidance to resolve the error. For known codes with an instructions section, this is the localized instruction text. For unknown codes, this property provides format guidance. | 68.0 | # ConnectApi.InsPolicyAddlInputIARep Input representation for the additional fields of an insurance policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields​List | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.Additional​FieldIARep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_field_i_a_re.htm "Input representation for the additional fields.")\> | Additional fields for the insurance policy. | Optional | 63.0 | | instanceKey | String | Instance key for the additional fields of the insurance policy. | Optional | 63.0 | # ConnectApi.InsPolicyIAInputRep Input representation details of an insurance policy.
Property Type Description Required or Optional Available Version
effectiveFromDate String Date from when the policy is effective.

This property isn't applicable to the out-of-sequence endorsement and policy reinstatement APIs.

 Optional 63.0
effectiveToDate String Date until when the policy is effective.

This property isn't applicable to the out-of-sequence endorsement and policy reinstatement APIs.

 Optional 63.0
policyName String Name of the insurance policy. Optional 63.0
policyNumber String Number of the policy. Optional 63.0
reference​PolicyNumber String Reference number that's used to link policies across terms.

If not specified, policies are linked by the insurance policy ID.

 Optional 65.0
# ConnectApi.InsPolicyLimitTrackingDetailsRep Output representation for the insurance policy limit tracking details. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | benefitName | String | Name of the benefit that's associated with the policy limit tracking. | 65.0 | | calcInitial​Amount | Double | Calculated currency amount that's used as the base value for tracking policy attribute consumption. | 65.0 | | calcInitialValue | Integer | Count that's used as the base for tracking policy attribute consumption. | 65.0 | | category | String | Category of the associated attribute. | 65.0 | | policyLimitId | String | ID of the insurance policy limit record. | 65.0 | | postedAmount | Double | Amount that's requested by the claimant when submitting the loss. | 65.0 | | postedValue | Integer | Count that's populated when submitting the loss. | 65.0 | | remainingAmount | Double | Remaining amount to carry forward for the next loss processing. | 65.0 | | remainingValue | Integer | Remaining value to carry forward for the next loss processing. | 65.0 | | scope | String | Scope for tracking the associated attribute. | 65.0 | | totalUsedAmount | Double | Total amount that's used to date. | 65.0 | | totalUsedValue | Integer | Total value that's used to date. | 65.0 | # ConnectApi.InsPolicyLmtCalcStandingNode Node representation for an insurance policy limit standing calculation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | applicableActions | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of actions that initiate attribute processing. | 65.0 | | category | String | Category of the limit. | 65.0 | | claimCoverageId | String | ID of the related claim coverage. | 65.0 | | claimId | String | ID of the related claim. | 65.0 | | durationType | String | Duration type over which the attribute consumption is actively monitored during processing. | 65.0 | | initialAmount | Double | Configured amount. | 65.0 | | initialValue | Integer | Configured value of the limit. | 65.0 | | itemType | String | Type of the item. | 65.0 | | parentMappedScopeId | String | ID of the parent product attribute mapped scope that's associated with the product attribute to define a parent-child relationship between attribute mappings. | 65.0 | | parentPolicyCoverageId | String | ID of the parent policy coverage that the policyCoverageId belongs to. | 67.0 | | pendingAmount | Double | Amount that's pending. | 65.0 | | pendingValue | Integer | Value that's pending. | 65.0 | | policyAssetId | String | ID of the related policy asset. | 65.0 | | policyCoverageId | String | ID of the related policy coverage. | 65.0 | | policyLimitId | String | ID of the insurance policy limit record. | 65.0 | | policyLimitStandingKey | String | Unique identifier for the insurance policy limit standing. | 65.0 | | policyParticipantId | String | ID of the related policy participant. | 65.0 | | predictedRemainingAmount | Double | Remaining amount to carry forward for the next payment after calculating the pending amount. | 65.0 | | predictedRemainingValue | Integer | Remaining value to carry forward for the next payment after calculating the pending value. | 65.0 | | prodtAttrMappedScopeId | String | ID of the product attribute mapped scope that defines how a product attribute is associated with a specific scope, such as a product type or category. | 65.0 | | remainingAmount | Double | Remaining amount to carry forward for the next payment. | 65.0 | | remainingValue | Integer | Remaining value to carry forward for the next payment. | 65.0 | | scope | String | Scope where the limit is applied. | 65.0 | | subCoverageName | String | Name of the sub-coverage. | 65.0 | | totalUsedAmount | Double | Total amount that's used to date. | 65.0 | | totalUsedValue | Integer | Total value that's used to date. | 65.0 | | trackingEndDate | Date | End date of the duration period that’s used to calculate the current standing. | 66.0 | | trackingStartDate | Date | Start date of the duration period that’s used to calculate the current standing. | 66.0 | # ConnectApi.InsPolicyLmtCalcStandingRepresentation Output representation for the current standings of the insurance policy limits. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Errros that are encountered during the processing of the API request. | 65.0 | | insPolicyLmtCalcStandingNodes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsPolicyLmtCalcStandingNode](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_lmt_calc_standing_node.htm "Node representation for an insurance policy limit standing calculation.")\> | List of policy limit current standing nodes. | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | 65.0 | # ConnectApi.InsPolicyLmtCurrentStandingsInputRep Input representation for the current standings of the insurance policy limits.
Property Type Description Required or Optional Available Version
claimCoverageId String Unique ID of the Claim Coverage. Optional 65.0
claimId String ID of the claim. Optional 65.0
options ConnectApi.LimitStandingOptionInputRepresentation Options for the calculation. Optional 65.0
policyAssetId String ID of the asset. Optional 65.0
policyCoverageId String ID of the coverage. Optional 65.0
policyId String ID of the insurance policy. Optional 65.0
policyParticipantId String ID of the participant. Optional 65.0
trackingDate Date Date on which the standing is calculated.

The default value is the current system date.

 Optional 66.0
# ConnectApi.InsPolicyTrxnIAInputRep Input representation details of an insurance policy transaction. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | Name of the transaction, such as Cancel Transaction. | Optional | 63.0 | # ConnectApi.InsPricingSetupValidationInputRepresentation Input representation of the quote, transaction type, and products to validate for pricing setup configuration. Provide at least one of quoteId, transactionType, or productIds for meaningful validation. If none are provided, the method returns isValid as true with no errors. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)")\> | List of Product2 record IDs to validate for product-level procedure plan configuration. | Optional | 68.0 | | quoteId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Quote record ID. When provided, the quote’s transaction type and date context are used for quote-level validation. | Optional | 68.0 | | transactionType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Transaction type developer name. Used for quote-level validation when quoteId isn’t provided, or to override the quote’s transaction type. | Optional | 68.0 | # ConnectApi.InsPricingSetupValidationRepresentation Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | Errors encountered during validation. This list includes pricing setup failures such as an invalid transaction type, a missing procedure plan, invalid procedure plan dates, an invalid context definition, or a pricing procedure that doesn’t have an active version for the evaluation date. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether the pricing setup is valid (true) or not (false). This value is true when no errors are detected. | 68.0 | # ConnectApi.InsProductDiscoveryValidationInputRepresentation Input representation of the product to validate for discovery setup. Identify the product by ID, product code, or developer name. Specify at least one of productId, productCode, or productName. If none is provided, validation fails with error code SF-INS-DSAV-00038. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productCode | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Product code used to look up the insurance product to validate for discovery setup. | Required if productId and productName aren't specified | 68.0 | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Product2 ID of the insurance product to validate for discovery setup. | Required if productCode and productName aren't specified | 68.0 | | productName | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Developer name used to look up the insurance product to validate for discovery setup. | Required if productId and productCode aren't specified | 68.0 | # ConnectApi.InsProductDiscoveryValidationRepresentation Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | Errors encountered during validation. This list includes request-level failures, such as a missing product identifier or a product that can’t be found, and discovery setup failures, such as a missing or inactive price book entry, selling model, pricing procedure, or decision table configuration. | 68.0 | | infos | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Details​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm "Output representation of the validation error of an attribute with the code and message.")\> | Informational messages about the validation context. For example, pricing procedure validation can be skipped when pricing is disabled for product discovery (SF-INS-DSAV-00042), and a reminder can indicate that decision tables may need a refresh (SF-INS-DSAV-00043). | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether the product discovery setup is valid (true) or not (false). This value is true when no errors are detected. | 68.0 | # ConnectApi.InsProductHierarchyValidationRepresentation Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Details​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm "Output representation of the validation error of an attribute with the code and message.")\> | Validation errors found for this related product. Each entry includes an error code and a message that describes how to resolve the failure. | 68.0 | | infos | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Details​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm "Output representation of the validation error of an attribute with the code and message.")\> | Informational messages for this product. Each entry includes a code and a message. | 68.0 | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the child product associated with the root insurance product identified by productId in the top-level response. | 68.0 | | productName | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Name of the child product. | 68.0 | # ConnectApi.InsProductModelValidationInputRepresentation Input representation of the details to validate an insurance product model. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the root insurance product for which you want to validate the model setup. The method validates this product and all associated products in its hierarchy, including direct children, component groups, and classification-based children. | Required | 68.0 | # ConnectApi.InsProductModelValidationRepresentation Output representation of the validation results for a product model and its hierarchy. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | Request-level errors that aren’t specific to a product in the hierarchy, such as a missing or invalid productId, insufficient access, or an unexpected server error. This list is empty when per-product validation runs. Product-specific failures are returned in products. | 68.0 | | infos | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Details​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm "Output representation of the validation error of an attribute with the code and message.")\> | Informational messages for the root product. Each entry includes a code and a message. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether all products in the hierarchy passed validation (true) or not (false). | 68.0 | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the insurance product that’s validated. | 68.0 | | products | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsProduct​Hierarchy​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_hierarchy_validation.htm "Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check.")\> | Related products in the root product hierarchy that have configuration errors. Each entry identifies a product and lists the validation failures for that product. | 68.0 | # ConnectApi.InsRequestValidationInputRepresentation Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiPath | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Path of the insurance Connect API request to validate. Supported values are insurance/quotes and insurance/product-rating. Requests for unsupported API paths return a valid response with an informational message. | Required | 68.0 | | requestBody | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Serialized JSON string to validate. The API parses the data and checks product codes, attributes, hierarchy, and instance keys against the org’s product model. The string must be valid JSON. | Required | 68.0 | # ConnectApi.InsRequestValidationRepresentation Output representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsDesignAdvisor​Error​Response​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm "Output representation of an error returned by an Insurance Design Advisor validation.")\> | List of request-level errors that prevented validation from being performed, such as a missing required input value. Empty or null when validation runs normally. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Overall validation status. Returns true when no validation issues are found; otherwise returns false. | 68.0 | | results | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsRequest​Validation​Result​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_request_validation_result.htm "Output representation of a single request validation finding. When the finding isn’t valid, instructions contains the issue and how to resolve it.")\> | List of validation findings generated during request validation. Each finding describes a detected issue or informational message. | 68.0 | # ConnectApi.InsRequestValidationResultRepresentation Output representation of a single request validation finding. When the finding isn’t valid, instructions contains the issue and how to resolve it. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | code | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Stable error code that identifies the validation finding. Null for informational or valid findings. | 68.0 | | instructions | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Description of the validation finding. When isValid is false, this property includes guidance for resolving the issue. For valid or informational findings, this property can describe context such as an unsupported API path. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether this finding passed validation (true) or not (false). When false, see instructions for the failure reason and correction. | 68.0 | # ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation Input representation for creating person accounts and portal users from group census members. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldMappings | [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_System_Map_toString.htm "HTML (New Window)") | Map of field API names from the Group Census Member object (key) to the Account object (value). | Optional | 65.0 | | groupCensusId | String | ID of the group census that contains the members to process. | Required | 65.0 | | groupCensusMemberIdList | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of group census member IDs to be processed. If not provided, all members of the specified group census are processed. | Optional | 65.0 | | matchingKeyList | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of field API names on the Group Census Member object used to identify and prevent the creation of duplicate person accounts. | Optional | 65.0 | | personAccountRecordType | String | Developer name of the person account record type to use for the new accounts. | Optional | 65.0 | | userDetails | [ConnectApi.PortalUserCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_portal_user_creation.htm "Input representation containing the details for creating a portal user.") | Details to create portal users. This property is required if the createPortalUsers parameter in the method call is set to true. | Optional | 65.0 | # ConnectApi.InsuranceAccountsAndUsersCreationRepresentation Output representation for the person account and user creation process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | accountsAndUsersDetails | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceMemberAccountAndUserDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_account_and_user_details.htm "Output representation that maps a source group census member to the IDs of the newly created person account and portal user.")\> | Details of the objects that contain the IDs of the person accounts and users that are created and mapped to their source group census members. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Details of errors that occurred during the operation. Each error includes details about why a specific group census member failed to process. | 65.0 | | groupCensusId | String | ID of the group census that's processed. | 65.0 | | isSuccess | Boolean | Indicates whether the overall operation was successful (true) or not (false). If any member fails to process, this value is false. | 65.0 | # ConnectApi.InsuranceAddMemberPlansInputRepresentation Input representation for adding plans to a group census member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusMemberPlans | List<[ConnectApi.GroupCensusMemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member_plan.htm "Input representation for a single plan that's associated with a group census member.")\> | List of plan details to add for the member. | Required | 65.0 | # ConnectApi.InsuranceAddMemberPlansOutputRepresentation Output representation for adding plans to a member. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while adding plans. | 64.0 | | isSuccess | Boolean | Indicates whether the API executed successfully. | 64.0 | | memberId | String | ID of the group census member. | 64.0 | | memberPlans | List | List of IDs for the member plan records that are successfully added. | 64.0 | # ConnectApi.InsuranceApexStringRepresentation Input representation for the Apex enabled string. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | key | String | API name of the field. | Optional | 65.0 | | value | String | Value to assign to the field. | Optional | 65.0 | # ConnectApi.InsuranceBulkCensusMgmtInputRepresentation Input representation for managing employee census data in bulk.
Property Type Description Required or Optional Available Version
batchSize Integer Number of records to process in each batch. Optional 65.0
contentDocumentId String ID of the content document (CSV file) that contains the census data. Required 65.0
contentDocumentVersionId String ID of the specific version of the content document. Optional 65.0
csvColumnMapping Map<String, String> Map where the key is the CSV column header and the value is the API name of the corresponding field in the GroupCensusMember object. Required 65.0
duplicateDetectionFields List<String> List of field API names that are used to generate a unique key for identifying duplicate members. Optional 65.0
shouldExecuteConfigurationRule Boolean Indicates whether to execute the configuration rules after processing the data (true) or not (false).

The default value is False. This property is applicable only for the census management enrollment API.

 Optional 65.0
# ConnectApi.InsuranceBulkCensusMgmtOutputRepresentation Output representation for the bulk employee census management process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\> | List of errors that occurred during processing. | 65.0 | | isSuccess | Boolean | Indicates whether the bulk operation is successfully initiated (true) or not (false). | 65.0 | | requestId | String | ID of the asynchronous bulk request. | 65.0 | # ConnectApi.InsuranceCensusFilterInputRepresentation Input representation of the filter criteria that select which policy records to include when generating a group census from a contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractGroupPlanIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the root contract group plans to include when generating the group census. | Optional | 67.0 | | objectName | String | API name of the object that the specified member record IDs belong to, such as Contact or PersonAccount. | Optional | 67.0 | | recordIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the specific records to include when generating the group census. Valid values are contact IDs and person account IDs. The IDs must belong to the object specified in objectName. | Optional | 67.0 | # ConnectApi.InsuranceCensusMgmtInputRepresentation Input representation for adding or updating census members. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | duplicateDetectionFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of field API names that are used to generate a unique key for identifying duplicate members. | Optional | 65.0 | | flowName | String | Name of the flow to use for processing group member data. | Optional | 65.0 | | members | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.GroupCensusMemberInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member.htm "Input representation for a group census member.")\> | List of group census members to add or update. | Required | 65.0 | # ConnectApi.InsuranceCensusMgmtOutputRepresentation Output representation for the insurance census management process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred during processing. | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | 65.0 | | memberIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the group census members that are successfully created or updated. | 65.0 | # ConnectApi.InsuranceCensusSummarySyncOutputRepresentation Output representation for the insurance employee census summary synchronization process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm)\> | List of errors that occurred during synchronization. | 65.0 | | groupCensus | [ConnectApi.InsuranceGroupCensusOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_census.htm "Output representation of a group census summary.") | Details of the synchronized group census summary. | 65.0 | | isSuccess | Boolean | Indicates whether the synchronization is successful (true) or not (false). | 65.0 | # ConnectApi.InsuranceCommissionProcessingInputRepresentation Input representation details of the insurance commission processing resource. The input includes the commissionStatementIds property required to process commission data. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | commission​StatementIds | Object | List of commission statement IDs to be processed. | Required | 63.0 | # ConnectApi.InsuranceCommissionProcessingOutputRepresentation Output representation details of the commission processing resource.
Property Name Type Description Available Version
message String Status message of the API execution. 63.0
status String Status of the API execution. Valid values are:
  • Success
  • Fail
 63.0
# ConnectApi.InsuranceContactsAndUsersCreationInputRepresentation Input representation to create contacts and portal users.
Property Type Description Required or Optional Available Version
fieldMappings Map<String, String> Map of field API names from the Group Census Member object (key) to the Contact object (value). Optional 65.0
groupCensusId String ID of the group census. Required 65.0
groupCensusMemberIdList List<String> List of group census member IDs. Optional 65.0
matchingKeyList List<String> List of matching keys from Group Census Member to find existing contacts. Optional 65.0
userDetails PortalUserCreation​InputRepresentation Details to create portal users.

This property is required if the createPortalUsers parameter in the method call is set to true

 Optional 65.0
# ConnectApi.InsuranceContactsAndUsersCreationRepresentation Output representation of the contact and user creation process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contactsAndUsersDetails | List<[ConnectApi.InsuranceMemberContactAndUserDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_contact_and_user_details.htm "Output representation of the created contact and portal user details for a group census member.")\> | Details of the contacts and users that are created. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Errors that occurred during the operation. | 65.0 | | groupCensusId | String | ID of the group census. | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | 65.0 | # ConnectApi.InsuranceContractCreationInputRepresentation Input representation for creating contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | List<[ConnectApi.ContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_contract_ite.htm "Addition fields to be added to the contract items.")\> | List of additional fields to add to contract items. | Optional | 65.0 | | contractEndDate | String | End date of the contract. | Required | 65.0 | | contractStartDate | String | Start date of the contract. | Required | 65.0 | | contractTerm | Integer | Contract terms in months. | Optional | 65.0 | | enrollmentEndDate | String | End date for plan enrollment. | Optional | 65.0 | | enrollmentStartDate | String | Start date for plan enrollment. | Optional | 65.0 | | quoteId | String | ID of the quote to create the contract from. | Required | 65.0 | # ConnectApi.InsuranceContractEndorseInputRepresentation Input representation of the quote ID, endorsement effective date, optional date-copy behavior, and additional fields used to create an endorsed contract version from a quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_item.htm "Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote.")\> | Additional fields for Contract, InsuranceContract, and ContractGroupPlan customization. Each item specifies an entity, optional productPath, and fields map. | Optional | 68.0 | | effectiveDate | String | Effective date of the endorsement, which is the start date of the endorsed contract, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 | | quoteId | String | ID of the quote from which to create the endorsed contract. | Required | 68.0 | | updateExistingContractDates | Boolean | Controls whether the endorsed contract's end date is copied from the source contract. When true or omitted, the source contract end date is copied. When false, the end date isn't populated from the source contract. | Optional | 68.0 | # ConnectApi.InsuranceContractEndorseRepresentation Output representation that's returned when an endorsed contract version is created from a quote. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contractId | String | ID of the endorsed contract that's created. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while endorsing the contract. Empty when the request succeeds. | 68.0 | | isSuccess | Boolean | Indicates whether the endorsed contract is created successfully (true) or not (false). | 68.0 | | message | String | Status message for the contract endorsement request. | 68.0 | # ConnectApi.InsuranceContractItem Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | API name of the object to apply the additional field values to, such as Contract, InsuranceContract, or ContractGroupPlan. | Optional | 68.0 | | fields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm "Input representation for the Apex enabled string.")\> | Additional fields and their values to apply to the entity. | Optional | 68.0 | | productPath | String | Product path used for hierarchical product identification, such as Health/Dental or Life/Term. | Optional | 68.0 | # ConnectApi.InsuranceContractRenewalInputRepresentation Input representation of the quote ID, renewal date, optional contract end date and term, and additional fields used to create a renewed-term contract from a quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_item.htm "Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote.")\> | Additional fields for Contract, InsuranceContract, and ContractGroupPlan customization. Each item specifies an entity, optional productPath, and fields map. | Optional | 68.0 | | contractEndDate | String | End date of the renewed contract term in ISO 8601 yyyy-MM-dd format. | Optional | 68.0 | | contractTerm | Integer | Duration of the renewed contract in months. The default value is 12. | Optional | 68.0 | | quoteId | String | ID of the quote from which to create the renewed contract. | Required | 68.0 | | renewalDate | String | Date that the renewed contract term takes effect, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 | # ConnectApi.InsuranceContractRenewalRepresentation Output representation that's returned when a renewed-term contract is created from a quote. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contractId | String | ID of the renewed contract that's created. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while renewing the contract. Empty when the request succeeds. | 68.0 | | isSuccess | Boolean | Indicates whether the renewed contract is created successfully (true) or not (false). | 68.0 | | message | String | Status message for the contract renewal request. | 68.0 | # ConnectApi.InsuranceContributionRepresentation Output representation of contribution information in individual rating. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | employeePremiumAmount | Double | Premium amount that's contributed by an employee. | 65.0 | | employerPremiumAmount | Double | Premium amount that's contributed by an employer. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Error details. | 65.0 | | groupClassContributionId | String | ID of the contribution record. | 65.0 | # ConnectApi.InsuranceCoverageRatingRepresentation Output representation of pricing results for an individual coverage. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contributions | [ConnectApi.InsuranceContributionRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contribution.htm "Output representation of contribution information in individual rating.") | Contribution details for the coverage, if applicable. | 65.0 | | coverageId | String | ID of the coverage. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Error details. | 65.0 | | proratedRates | [ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.") | Prorated rates for the coverage. | 65.0 | | rates | [ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.") | Rate details for the coverage. | 65.0 | # ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation Input representation for creating a quote from an existing insurance contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceQuoteItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_quote_item.htm "Input representation for an insurance quote item that identifies an entity, product path, and additional field overrides.")\> | List of additional field overrides to apply to the Quote and QuoteLineItem entities, keyed by entity and product path. | Optional | 68.0 | | censusRatingType | String | Census rating type to set on the quote record, such as Member Based or Summary Based. | Optional | 67.0 | | configOptions | [ConnectApi.InsGBQuoteConfigOptions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_g_b_quote_config_options.htm "Input representation for configuration options when creating an insurance group benefits quote.") | Configuration options for create quote from contract. | Optional | 67.0 | | eventEffectiveFromDate | String | Start date to set on the quote record. | Optional | 67.0 | | eventEffectiveToDate | String | End date to set on the quote record. | Optional | 67.0 | | groupCensusId | String | ID of the group census to associate with the quote record. | Optional | 67.0 | | insuranceQuoteType | String | Insurance quote type to set on the quote record, such as Endorsement or Renewal. | Optional | 67.0 | | quoteName | String | Name of the quote being created. | Optional | 67.0 | | ratingDate | String | Rating date to set on the quote record. | Optional | 67.0 | | transactionType | String | Transaction type to set on the quote record, such as GB Endorsement or GB Renewal. | Optional | 67.0 | # ConnectApi.InsuranceCreateQuoteFromContractOutputRepresentation Output representation returned when creating a quote from an existing insurance contract. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred during quote creation. | 67.0 | | isSuccess | Boolean | Indicates whether the quote was created successfully (true) or not (false). | 67.0 | | message | String | Status message for the quote creation request. | 67.0 | | quoteId | String | ID of the quote that was created. | 67.0 | # ConnectApi.InsuranceDeleteMemberPlansInputRepresentation Input representation for deleting a member's plans. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | plans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of group census member plan IDs to delete. | Required | 65.0 | # ConnectApi.InsuranceDeleteMemberPlansOutputRepresentation Output representation for the member plan deletion process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred during the deletion process. | 65.0 | | isSuccess | Boolean | Indicates whether the API executed successfully (true) or not (false). | 65.0 | | memberId | String | ID of the group census member. | 65.0 | # ConnectApi.InsuranceErrorRepresentation Output representation for an error that occurred during an insurance process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | additionalInfo | Map | Map of additional details about the error, such as the ID of the record that caused the failure. | 65.0 | | code | String | Error code. | 65.0 | | message | String | Detailed error message. | 65.0 | # ConnectApi.InsuranceGenerateCensusInputRepresentation Input representation of the census name and type, optional policy date, filters, and generation options used to create a group census from the policies on a contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusName | String | Name of the group census to create. | Optional | 67.0 | | censusType | String | Type of group census to generate, such as Enrollment or Quote. | Required | 67.0 | | filter | [ConnectApi.InsuranceCensusFilterInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_filter.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that indicate which policy records to include when generating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 67.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating the group census, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 67.0 | | requestId | String | ID of the asynchronous request from a previous run. Use this value to regenerate a group census that failed in the previous run. | Required when you regenerate a group census that failed in the previous run. | 67.0 | | shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census details (true) or not (false). | Optional | 67.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include insurance plan details for each member in the generated group census (true) or not (false). | Optional | 68.0 | # ConnectApi.InsuranceGenerateCensusRepresentation Output representation that's returned when you start generating a group census from the policies on a group benefits contract. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while generating the group census. Shows null when the request succeeds. | 67.0 | | groupCensusId | String | ID of the group census record that's created from the contract policies. | 67.0 | | isSuccess | Boolean | Indicates whether the group census is created successfully (true) or not (false). | 68.0 | | message | String | Message describing the result of the asynchronous census generation process. | 68.0 | | requestId | String | ID of the asynchronous request that generates the group census for the specified group benefits contract. Use this ID to track the job or to retry a failed run. | 67.0 | # ConnectApi.InsuranceGenerateRefreshCensusMembersAdditionalFieldsRep Input representation of the additional field values to apply to group census members during a generate or refresh census members operation. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | members | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceUpsertMemberRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_upsert_member.htm "Input representation of a group census member and the additional field values to apply during an upsert operation.")\> | List of members and their additional field values. | Optional | 68.0 | # ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep Input representation of the census details, member identifiers, optional policy date, and additional fields used to generate or update group census members from policy information on a contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [ConnectApi.InsuranceGenerateRefreshCensusMembers​AdditionalFieldsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_refresh_census_members_additional_fields.htm "Input representation of the additional field values to apply to group census members during a generate or refresh census members operation.") | Additional field values to apply to each group census member during the upsert operation. Use this parameter to set nonstandard fields, such as extended or custom fields. | Optional | 68.0 | | censusName | String | Name for the group census record. | Optional | 68.0 | | censusType | String | Type of census, for example Enrollment or Quote. | Optional | 68.0 | | contactIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Contact IDs used to extract member information. If you specify contact IDs, you must also specify a policy ID to correctly identify the associated members. | Optional | 68.0 | | groupCensusId | String | ID of the group census. Required when you update existing group census member details. | Required when you update existing group census member details. | 68.0 | | personAccountIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the Person Accounts used to identify the members to include when processing the group census. Member information is extracted from the specified accounts. | Optional | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating or updating group census member details, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 | | policyIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Policy IDs from which member information is retrieved for the specified contacts or accounts. | Optional | 68.0 | | shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census data (true) or not (false). | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members in the processed group census (true) or not (false). If set to true, the group census includes insurance plan details for each member. | Optional | 68.0 | # ConnectApi.InsuranceGenerateRefreshCensusMembersRep Output representation that's returned when you generate or update group census members from policy information on a group benefits contract. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors encountered during the generate or update census members operation. Shows null when the request succeeds. | 68.0 | | groupCensusId | String | ID of the group census whose member details are generated or updated. | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 68.0 | # ConnectApi.InsuranceGetMemberPlansOutputRepresentation Output representation of eligible plans for a single member. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | error | [ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.") | Error details that are associated with the API request. | 65.0 | | memberId | String | ID of the group census member (primary or dependent). | 65.0 | | plans | Map | Map of eligible plans, where the key is the plan category, such as Medical and Dental, and the value is a list of plans in that category. | 65.0 | # ConnectApi.InsuranceGetMembersPlans Output representation for a member's eligible plans. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | memberId | String | ID of the primary group census member. | 65.0 | | membersPlansDetails | [ConnectApi.InsuranceMembersPlansDetailsListRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_members_plans_details_list.htm "A wrapper for a list of members and their eligible plans.") | List of the eligible plans for the primary member and any dependents. | 65.0 | # ConnectApi.InsuranceGroupCensusOutputRepresentation Output representation of a group census summary. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | fullTimeMemberCount | Integer | Total number of full-time members. | 65.0 | | grpCensusGrpClassSummaryList | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceGrpCensusGrpClassSummaryOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_grp_census_grp_class_summary_output.htm "Output representation of census summary data aggregated by group class.")\> | List of census summaries that are aggregated by group class. | 65.0 | | id | String | ID of the group census summary. | 65.0 | | mbrWithMoreThan1ChldCount | Integer | Total number of members who have more than one child dependent. | 65.0 | | mbrWithMoreThan2ChldCount | Integer | Total number of members who have more than two child dependents. | 65.0 | | mbrWithoutDependentCount | Integer | Total number of members who have no dependents. | 65.0 | | memberOptOutCount | Integer | Total number of members who have actively opted out of all insurance plans. | 65.0 | | memberWithDependentCount | Integer | Total number of members who have at least one dependent of any type. | 65.0 | | memberWithOneChildCount | Integer | Total number of members who have exactly one child dependent. | 65.0 | | memberWithSpouseCount | Integer | Total number of members who have a spouse listed as a dependent. | 65.0 | | partTimeMemberCount | Integer | Total number of part-time members. | 65.0 | | totalDependents | Integer | Total of all dependent records across all members in the census. | 65.0 | | totalMemberPlusDependent | Integer | Total of all members and all their dependents. | 65.0 | | totalMembers | Integer | Total number of primary members in the census. | 65.0 | # ConnectApi.InsuranceGroupEndorsementInputRepresentation Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to run to update member policies. The default value is the API name of the Apply Contract Adjustments to Member Policies flow: ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the method uses the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. | Optional | 68.0 | # ConnectApi.InsuranceGroupEndorsementRepresentation Output representation that's returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | List of errors with a message and an error code that occurred while validating the request or scheduling the asynchronous job. An empty list indicates that the job was scheduled successfully. | 68.0 | | requestId | String | ID of the asynchronous job request that updates member policies. Use this ID to track the status of the job. | 68.0 | # ConnectApi.InsuranceGroupPlanInputRepresentation Input representation for a contract group plan. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | List<[ConnectApi.AttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_attribute.htm "Input representation for Group Census Member Plan attribute.")\> | Attribute overrides for this plan or coverage. | Optional | 68.0 | | coverages | List<[ConnectApi.InsuranceGroupPlanInputRepresentation](# "Input representation for a contract group plan.")\> | List of coverages that are associated with this plan. | Optional | 65.0 | | planId | String | ID of the contract group plan. | Required | 65.0 | | productCode | String | Product code used for coverages when the contract group plan ID isn’t known. This property is valid only within the coverages property. | Optional | 68.0 | # ConnectApi.InsuranceGroupPlanOutputRepresentation Output representation of an insurance group plan. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributes | List<[ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.")\> | List of attributes for the contract group plan. | 65.0 | | coverages | List<[ConnectApi.InsuranceGroupPlanOutputRepresentation](# "Output representation of an insurance group plan.")\> | List of coverages for the plan. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Errors for this plan or coverage returned by the configurator. | 68.0 | | isOptional | Boolean | Indicates whether the plan is optional (true) or not (false). | 65.0 | | planId | String | ID of the contract group plan. | 65.0 | | planName | String | Name of the contract group plan. | 65.0 | | productCategory | String | Category of the contract group plan. | 65.0 | | productCode | String | Product code returned for off-contract coverages when the contract group plan ID isn’t available. | 68.0 | | uiTreatments | List<[ConnectApi.InsuranceGroupPlanUiTreatmentOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_plan_ui_treatment.htm "Output representation of a UI treatment returned by the configurator for a plan or coverage.")\> | UI treatments for this plan or coverage returned by the configurator. | 68.0 | # ConnectApi.InsuranceGroupPlanUiTreatmentOutputRepresentation Output representation of a UI treatment returned by the configurator for a plan or coverage. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | details | Map | UI treatment details in key-value pairs, including keys such as planId, productId, prcId, attributeCode, and attributeValue. | 68.0 | | uiTreatmentTarget | String | UI treatment target, such as product, attribute, component, quantity, and attribute\_picklist\_value. | 68.0 | | uiTreatmentType | String | Type of UI action to perform, such as hide or disable. | 68.0 | # ConnectApi.InsuranceGroupRatingInputRepresentation Input representation for rating a group benefits quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | batchSize | Integer | Number of records to process in each batch for the rating calculation. | Optional | 65.0 | | quoteLineItemIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of quote line item IDs to be included in the rating process. | Optional | 65.0 | | ratingDate | String | Date to use for the rating calculation. If not specified, the API uses the effective date of the quote. | Optional | 65.0 | # ConnectApi.InsuranceGroupRatingOutputRepresentation Output representation for the group benefits rating process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that are encountered during the rating process. | 65.0 | | isSuccess | Boolean | Indicates whether the group rating process is successful (true) or not (false). | 65.0 | # ConnectApi.InsuranceGroupRenewalInputRepresentation Input representation of the optional flow and repricing settings used to renew member policies for a group census. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to use for member-policy renewal. If not specified, the default RenewMemberPolicies flow is used. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the method uses the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. | Optional | 68.0 | # ConnectApi.InsuranceGroupRenewalRepresentation Output representation that's returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | List of errors that occurred while validating the request or scheduling the asynchronous renewal job. An empty list indicates that the job was scheduled successfully. | 68.0 | | requestId | String | ID of the asynchronous bulk request to renew member policies of a group census. Use this ID to track the status of the job. | 68.0 | # ConnectApi.InsuranceGrpCensusGrpClassSummaryOutputRepresentation Output representation of census summary data aggregated by group class. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | fullTimeMemberCount | Integer | Total number of full-time members for this group class. | 65.0 | | groupCensusId | String | ID of the group census. | 65.0 | | groupClassId | String | ID of the group class. | 65.0 | | id | String | ID of the group census group class summary record. | 65.0 | | mbrWithMoreThan1ChldCount | Integer | Total number of members who have more than one child dependent for this group class. | 65.0 | | mbrWithMoreThan2ChldCount | Integer | Total number of members who have more than two child dependents for this group class. | 65.0 | | mbrWithoutDependentCount | Integer | Total number of members who have no dependents for this group class. | 65.0 | | memberOptOutCount | Integer | Total number of members who have actively opted out of all insurance plans for this group class. | 65.0 | | memberWithDependentCount | Integer | Total number of members who have at least one dependent of any type, such as spouse or children for this group class. | 65.0 | | memberWithOneChildCount | Integer | Total number of members who have exactly one child dependent for this group class. | 65.0 | | memberWithSpouseCount | Integer | Total number of members who have a spouse listed as a dependent for this group class. | 65.0 | | partTimeMemberCount | Integer | Total number of part-time members for this group class. | 65.0 | | totalDependents | Integer | Total number of dependents for this group class. | 65.0 | | totalMemberPlusDependent | Integer | Total of all members and all their dependents for this group class. | 65.0 | | totalMembers | Integer | Total number of members for this group class. | 65.0 | # ConnectApi.InsuranceIndividualEnrollmentInputRepresentation Input representation for enrolling an individual member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of an optional flow to run as part of the enrollment process. The default value is Process Group Census Member Data. | Optional | 65.0 | | plan | String | ID of contract group plan to enroll the member in. | Required | 65.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the method uses the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. | Optional | 68.0 | # ConnectApi.InsuranceIndividualEnrollmentOutputRepresentation Output representation for the individual enrollment process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that are encountered during the enrollment process. | 65.0 | | isSuccess | Boolean | Indicates whether the enrollment process is successful (true) or not (false). | 65.0 | | policies | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.FamilyPolicyInfoOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_family_policy_info.htm "Output representation of the policy information for an enrollment or mid-term adjustment.")\> | List of policies that are created as part of the enrollment process. | 65.0 | # ConnectApi.InsuranceIndividualMtaInputRepresentation Input representation for applying a mid-term adjustment to a group census member's insurance policies. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of an optional custom flow to run as part of the mid-term adjustment. If you don't specify a value, the default flow is used. | Optional | 68.0 | | plans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the root contract group plans to adjust for the member. If you don't specify this property or pass an empty list, the method adjusts every plan that the member is currently subscribed to. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the method uses the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. | Optional | 68.0 | # ConnectApi.InsuranceIndividualMtaOutputRepresentation Output representation that's returned after a mid-term adjustment is applied to a group census member's insurance policies. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that are encountered during the mid-term adjustment. | 68.0 | | isSuccess | Boolean | Indicates whether the mid-term adjustment is successful (true) or not (false). | 68.0 | | policies | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.FamilyPolicyInfoOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_family_policy_info.htm "Output representation of the policy information for an enrollment or mid-term adjustment.")\> | List of policies that are created or updated as part of the mid-term adjustment. | 68.0 | # ConnectApi.InsuranceIssueContractInputRepresentation Input representation of the quote ID, optional contract dates and term, transaction detail level, and additional fields used to issue a group benefits contract from a quote. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceContractItem](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_item.htm "Input representation of an entity, product path, and field values used to extend a contract when you issue it from a quote.")\> | Additional fields for Contract, InsuranceContract, and ContractGroupPlan customization. Each item specifies an entity, optional productPath, and fields map. | Optional | 68.0 | | contractEndDate | String | End date of the contract in ISO 8601 yyyy-MM-dd format. If specified, this value overrides the contract end date that's derived from the quote. | Optional | 68.0 | | contractStartDate | String | Start date of the contract in ISO 8601 yyyy-MM-dd format. If specified, this value overrides the contract start date that's derived from the quote. | Optional | 68.0 | | contractTerm | Integer | Duration of the contract in months. If specified, this value overrides the contract term derived from the quote. | Optional | 68.0 | | quoteId | String | ID of the quote from which to create the contract. | Required | 68.0 | | transactionDetailLevel | String | Level of transaction detail to include when issuing the contract. Valid values are PLAN\_LEVEL, COVERAGE\_LEVEL, and CHARGE\_LEVEL. The default value is PLAN\_LEVEL. | Optional | 68.0 | # ConnectApi.InsuranceIssueContractRepresentation Output representation that's returned when a group benefits contract is issued synchronously from a quote. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contractId | String | ID of the contract that's issued. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while issuing the contract. Empty when the request succeeds. | 68.0 | | isSuccess | Boolean | Indicates whether the contract is issued successfully (true) or not (false). | 68.0 | | message | String | Status message for the contract issuance request. | 68.0 | # ConnectApi.InsuranceMemberAccountAndUserDetailsRepresentation Output representation that maps a source group census member to the IDs of the newly created person account and portal user. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | groupCensusId | String | ID of the group census. | 65.0 | | groupCensusMemberId | String | ID of the source group census member. | 65.0 | | personAccountId | String | ID of the person account that's created. | 65.0 | | userId | String | ID of the portal user that's created. This property is null if portal user creation isn't requested. | 65.0 | # ConnectApi.InsuranceMemberContactAndUserDetailsRepresentation Output representation of the created contact and portal user details for a group census member. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contactId | String | ID of the created or existing contact. | 65.0 | | groupCensusId | String | ID of the group census. | 65.0 | | groupCensusMemberId | String | ID of the group census member. | 65.0 | | userId | String | ID of the created portal user. | 65.0 | # ConnectApi.InsuranceMemberRatingDetailsInputRepresentation Input representation for the details of an individual member to be rated. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the member. | Required | 65.0 | | plans | List<[InsuranceMemberRating​PlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating_plans.htm "Input representation for plan details used in individual rating.")\> | Plan details for rating. | Required | 65.0 | # ConnectApi.InsuranceMemberRatingDetailsRepresentation Output representation of rating details for an individual member. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of error details. | 65.0 | | memberId | String | ID of the member. | 65.0 | | plans | List<[ConnectApi.InsurancePlanRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plan_rating.htm "Output representation of pricing results for an individual plan.")\> | Rating details for the plan. | 65.0 | # ConnectApi.InsuranceMemberRatingInputRepresentation Input representation for the individual member rating API. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the member's rating is calculated. | Required | 65.0 | | members | List<[InsuranceMemberRating​DetailsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating_details.htm "Input representation for the details of an individual member to be rated.")\> | Details of the members and their plans to be rated. | Required | 65.0 | # ConnectApi.InsuranceMemberRatingPlansInputRepresentation Input representation for plan details used in individual rating. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | planCoverageIds | List | Coverage IDs within the plan. | Optional | 65.0 | | planId | String | ID of the plan. | Required | 65.0 | # ConnectApi.InsuranceMemberRatingRepresentation Output representation of the rating results for individual members. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Error details. | 65.0 | | id | String | A unique identifier for this rating representation. | 65.0 | | pricingResults | List<[ConnectApi.InsuranceMemberRatingDetailsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_rating_details.htm "Output representation of rating details for an individual member.")\> | Details of pricing results from individual ratings. | 65.0 | # ConnectApi.InsuranceMembersPlansDetailsListRepresentation A wrapper for a list of members and their eligible plans. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | values | List<[ConnectApi.InsuranceGetMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_get_member_plans.htm "Output representation of eligible plans for a single member.")\> | List of members (primary and dependent) and their associated eligible plans or errors. | 65.0 | # ConnectApi.InsuranceMessageOutputRepresentation Output representation of insurance message. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | message | String | Content of the message. | 65.0 | | type | String | Type of message, such as Info or Error. | 65.0 | # ConnectApi.InsuranceObjectMapRepresentation Output representation for attributes and other mapped data. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | data | Map | Map with a string key and an object value. | 65.0 | # ConnectApi.InsuranceOutputRepresentation Output representation details of the bulk operations of the insurance policies. This class is abstract. Superclass of [ConnectApi.InsurancePolicyBulkOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_bulk_output.htm "Output representation details of the bulk cancel policy resource.").
Property Name Type Description Available Version
errors List<ConnectApi.ErrorResponseRepresentation> List of the errors encountered during the processing of the API request. 63.0
message String Status message of the API execution. 63.0
status String Status of the API execution. Valid values are:
  • Success
  • Fail
 63.0
# ConnectApi.InsurancePlanListOutputRepresentation A wrapper for a list of insurance plans. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | values | List<[ConnectApi.InsurancePlanOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plan.htm "Output representation of an insurance plan.")\> | List of insurance plans. | 65.0 | # ConnectApi.InsurancePlanOutputRepresentation Output representation of an insurance plan. | Property Name | Type | Description | Available Version | | | --- | --- | --- | --- | --- | | attributes | List<[ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.")\> | Attributes for the plan. | 65.0 | 65.0 | | coverages | List<[ConnectApi.InsurancePlanOutputRepresentation](# "Output representation of an insurance plan.")\> | Coverages for the plan. | 65.0 | 65.0 | | isOptional | Boolean | Indicates if the plan is optional for the group census member (true) or not (false). | Small, 65.0 | 65.0 | | isPrimarySubscribed | Boolean | Indicates if the primary group census member is subscribed to the plan (true) or not (false). | Small, 65.0 | 65.0 | | isSubscribed | Boolean | Indicates if the group census member is subscribed to the plan (true) or not (false). | Small, 65.0 | 65.0 | | planDescription | String | Description of the contract group plan. | Small, 65.0 | 65.0 | | planId | String | ID of the contract group plan. | Small, 65.0 | 65.0 | | planName | String | Name of the contract group plan. | Small, 65.0 | 65.0 | # ConnectApi.InsurancePlanRatingRepresentation Output representation of pricing results for an individual plan. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contributions | [ConnectApi.InsuranceContributionRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contribution.htm "Output representation of contribution information in individual rating.") | Contribution details for the plan, if applicable. | 65.0 | | coverages | List<[ConnectApi.InsuranceCoverageRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_coverage_rating.htm "Output representation of pricing results for an individual coverage.")\> | Coverage details for the plan. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | Error details. | 65.0 | | id | String | ID of the plan. | 65.0 | | proratedRates | [ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.") | Prorated rates for the plan. | 65.0 | | rates | [ConnectApi.InsuranceObjectMapRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_object_map.htm "Output representation for attributes and other mapped data.") | Rate details for the plan. | 65.0 | # ConnectApi.InsurancePlansEligibilityOutputRepresentation Output representation for the employee plan eligibility check. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | contextId | String | ID of the context that's used for the eligibility check. | 65.0 | | errors | List<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred during the eligibility check. | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | memberId | String | ID of the group census member. | 65.0 | | planEligibilityDetails | [ConnectApi.EligiblePlanDetailsOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_eligible_plan_details.htm "Output representation containing the details of eligible plans.") | Details of the plan eligibility check. | 65.0 | # ConnectApi.InsurancePlansEligibilityPatchInputRepresentation Input representation for checking plan eligibility by updating an existing context. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | List<[ConnectApi.InsuranceGroupPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_plan.htm "Input representation for a contract group plan.")\> | List of contract group plans to add to the eligibility check. | Optional | 65.0 | | contextId | String | ID of the existing eligibility context to update. | Required | 65.0 | | deletedPlans | List<[ConnectApi.InsuranceGroupPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_plan.htm "Input representation for a contract group plan.")\> | List of contract group plans to remove from the eligibility check. | Optional | 65.0 | | updatedPlans | List<[ConnectApi.InsuranceGroupPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_plan.htm "Input representation for a contract group plan.")\> | List of contract group plans to update during the eligibility check. | Optional | 65.0 | # ConnectApi.InsurancePlansEligibilityPostInputRepresentation Input representation for checking plan eligibility by creating a new context. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | plans | List<[ConnectApi.InsuranceGroupPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_plan.htm "Input representation for a contract group plan.")\> | List of contract group plans to check for eligibility. | Required | 65.0 | # ConnectApi.InsurancePolicyBillingInfoInputRepresentation Input representation for insurance policy billing. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | billDayOfMonth | Integer | Day of the month on which the bill must be generated. | Required | 67.0 | | billToContact | String | Contact ID to use for billing. | Required | 67.0 | | billingType | String | Type of billing to use for the insurance policy. | Required | 67.0 | # ConnectApi.InsurancePolicyBulkFieldMapInputRepresentation Input representation for Insurance Policy Bulk Lifecycle process APIs with per-policy field value maps. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policies | Object | List of Insurance policies with their field value maps. | Required | 67.0 | # ConnectApi.InsurancePolicyBulkInputRepresentation Input representation details to manage policies in bulk. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains the name-value pairs that store the details of the insurance policy. | Required | 64.0 | | insurancePolicyIds | Object | List of Insurance policy IDs. | Required | 64.0 | # ConnectApi.InsurancePolicyBulkOutputRepresentation Output representation details of the bulk cancel policy resource. Subclass of [ConnectApi.InsuranceOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_output.htm "Output representation details of the bulk operations of the insurance policies."). No additional properties. # ConnectApi.InsurancePolicyBulkRenewInputRepresentation Input representation details of the renew insurance policies in bulk resource. The input includes the list of insurance policy IDs to be renewed and the details of the associated fields of the insurance policies. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains the name-value pairs that store the details of the insurance policy. | Required | 64.0 | | insurance​PolicyIds | Object | List of insurance policy IDs. | Required | 64.0 | # ConnectApi.InsurancePolicyCancellationInputRepresentation Input representation for the cancel policy request. Includes the cancellation effective date, the cancellation reason, and the target status for the canceled policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cancellationEffectiveDate | String | Date after which the policy is no longer valid. | Required | 67.0 | | cancellationReason | String | Reason for canceling the policy. | Required | 67.0 | | status | String | Status to set on the canceled policy, such as Canceled. | Required | 67.0 | # ConnectApi.InsurancePolicyCancellationRepresentation Output representation for the cancel policy response. Contains the transaction ID, a list of impacted policy versions, and any errors that occurred during the cancellation process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List | List of errors that occurred during the cancellation process. | 67.0 | | impactedPolicyVersions | List | List of impacted policy versions resulting from the cancellation. | 67.0 | | transactionId | String | ID of the transaction generated for the cancellation. | 67.0 | # ConnectApi.InsurancePolicyDraftInputRepresentation Input representation for the endorsement draft request. Includes a field value map that specifies the insurance policy fields to override in the draft. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains the name-value pairs of insurance policy fields to override in the endorsement draft. | Required | 67.0 | # ConnectApi.InsurancePolicyDraftOutputRepresentation Output representation for the endorsement draft response. Contains the policy ID of the created draft and any errors that occurred during the process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List | List of errors that occurred during the endorsement draft process. | 67.0 | | policyId | String | ID of the policy for which the endorsement draft is created. | 67.0 | # ConnectApi.InsurancePolicyInputRepresentation Input representation details of an insurance policy.
Property Type Description Required or Optional Available Version
effectiveFromDate String Date from when the policy is effective.

This property isn't applicable to the out-of-sequence endorsement and policy reinstatement APIs.

 Optional 63.0
effectiveToDate String Date until when the policy is effective.

This property isn't applicable to the out-of-sequence endorsement and policy reinstatement APIs.

 Optional 63.0
policyName String Name of the insurance policy. Optional 63.0
policyNumber String Number of the policy. Optional 63.0
referencePolicy​Number String Reference number that's used to link policies across terms.

If not specified, policies are linked by the insurance policy ID.

This property isn't applicable to the out-of-sequence endorsement and policy reinstatement APIs.

 Optional 65.0
# ConnectApi.InsurancePolicyIssueOutputRepresentation Output representation for the issue or endorse policy response. Contains the transaction ID and any errors that occurred during the process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List | List of errors that occurred during the issue or endorse process. | 67.0 | | transactionId | String | ID of the transaction generated for the issue or endorsement. | 67.0 | # ConnectApi.InsurancePolicyOutputRepresentation Output representation of the insurance policy proration or rollup result. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm)\> | List of errors. | 66.0 | | message | String | Response message. | 66.0 | # ConnectApi.InsurancePolicyProcessOutputRepresentation Output representation details of the insurance policy renewal resource. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | policyId | String | ID of the insurance policy to be returned. | 63.0 | # ConnectApi.InsurancePolicyReinstatementInputRepresentation Input representation for the reinstate policy request. Includes insurance policy field overrides and the reinstatement date. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insurancePolicy | Object | JSON object that contains the insurance policy fields to override in the reinstated policy. | Optional | 67.0 | | reinstatementDate | String | Date when the reinstatement takes effect. | Required | 67.0 | # ConnectApi.InsurancePolicyReinstatementRepresentation Output representation for the reinstate policy response. Contains the reinstated policy ID, the transaction ID, and any errors that occurred during the reinstatement process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List | List of error details that occurred during the reinstatement process. | 67.0 | | policyId | String | ID of the policy that's reinstated. | 67.0 | | transactionId | String | ID of the transaction generated to reinstate the policy. | 67.0 | # ConnectApi.InsurancePolicyRenewInputRepresentation Input representation details of the resource to renew an insurance policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains name-value pairs that store the details of the insurance policy. | Required | 63.0 | # ConnectApi.InsurancePolicyTransactionInputRepresentation Input representation details of an insurance policy transaction. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | Name of the transaction, such as Cancel Transaction. | Optional | 63.0 | # ConnectApi.InsuranceQuoteItem Input representation for an insurance quote item that identifies an entity, product path, and additional field overrides. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | Entity name to apply the field overrides to, such as Quote or QuoteLineItem. | Optional | 68.0 | | fields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm "Input representation for the Apex enabled string.")\> | Additional fields and their values to apply to the entity. | Optional | 68.0 | | productPath | String | Product path used for hierarchical product identification, such as Health/Dental or Life/Term. | Optional | 68.0 | # ConnectApi.InsuranceRefreshCensusInputRepresentation Input representation of the group census ID, date range, optional filters, and update options used to refresh a group census from policy enrollments and endorsements on a contract. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | endDate | String | End date of the time period used to find policy enrollments and endorsements that update the group census and associated records, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 | | filter | [ConnectApi.InsuranceCensusFilterInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_filter.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that identify which policy records associated with the insurance contract to include when updating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 | | groupCensusAdditionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm "Input representation for the Apex enabled string.")\> | Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value. | Optional | 68.0 | | groupCensusId | String | ID of the group census record to update. | Required | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for updating member and plan configuration details, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Required | 68.0 | | requestId | String | ID of the asynchronous request from a previous run. Use with groupCensusId to retry updating the records that failed in a previous run. | Required to rerun the asynchronous job to update a group census that failed in a previous run. | 68.0 | | shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with the updated group census details (true) or not (false). The default value is false. | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members when updating the group census (true) or not (false). The default value is false. | Optional | 68.0 | | startDate | String | Start date of the time period used to find policy enrollments and endorsements that update the group census and associated records, in ISO 8601 yyyy-MM-dd format. | Required | 68.0 | # ConnectApi.InsuranceRefreshCensusRepresentation Output representation that's returned when you start updating a group census from policy enrollments and endorsements on a group benefits contract. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred while refreshing the group census. Shows null when the request succeeds. | 68.0 | | groupCensusId | String | ID of the group census record that's updated. | 68.0 | | isSuccess | Boolean | Indicates whether the API operation started successfully (true) or not (false). | 68.0 | | message | String | Message describing the result of the asynchronous census refresh process. | 68.0 | | requestId | String | ID of the asynchronous request that updates the group census for the specified group benefits contract. Use this ID to track the job or to retry a failed run. | 68.0 | # ConnectApi.InsuranceTransactionBillingInputRepresentation Input representation of the details to create billing schedules from an insurance transaction. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insPolicyTransactionId | String | ID of the insurance policy transaction record. | Required | 66.0 | # ConnectApi.InsuranceTransactionBillingOutputRepresentation Output representation of the result of creating billing schedules from an insurance transaction. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm)\> | List of errors that are encountered during the API request. | 65.0 | | message | String | Text message of the API request. | 65.0 | # ConnectApi.InsuranceUpdateMemberPlansInputRepresentation Input representation for updating the plans for a group census member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | List<[ConnectApi.GroupCensusMemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member_plan.htm "Input representation for a single plan that's associated with a group census member.")\> | List of plans to add for the member. | Optional | 65.0 | | deletedPlans | List | List of group census member plan IDs to delete. | Optional | 65.0 | | upsertedPlans | List<[ConnectApi.GroupCensusMemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_member_plan.htm "Input representation for a single plan that's associated with a group census member.")\> | List of existing member plans to update or add if they don't exist, including attribute-level changes to plans the member already has. | Optional | 68.0 | # ConnectApi.InsuranceUpdateMemberPlansOutputRepresentation Output representation for the member plan update process. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_error.htm "Output representation for an error that occurred during an insurance process.")\> | List of errors that occurred during the update. | 65.0 | | failedPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of plan IDs that failed to be added or deleted. | 65.0 | | isSuccess | Boolean | Indicates whether the overall operation is successful (true) or not (false). | 65.0 | | memberId | String | ID of the group census member. | 65.0 | | updatedMemberPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of IDs for the member plan records that are successfully updated. | 65.0 | # ConnectApi.InsuranceUpsertMemberRep Input representation of a group census member and the additional field values to apply during an upsert operation. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsuranceApexStringRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_apex_string_representatio.htm "Input representation for the Apex enabled string.")\> | Key-value pairs that specify the additional field values to apply to the specified member. | Optional | 68.0 | | memberId | String | Unique identifier of the member. This value associates the additional field values with the corresponding member. | Optional | 68.0 | # ConnectApi.InsValidateUserPermissionsInputRepresentation Input representation that specifies the insurance operation and optional user ID for a permissions check. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | targetOperation | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Insurance operation to validate against the user’s permission. Valid values are: executeQuote, browseCatalog, createQuote, rateProduct, createPolicy, endorsePolicy, cancelPolicy, reinstatePolicy, createSurcharge, createUnderwritingRules, and createClause. Unknown or blank values return an invalid result with the list of supported identifiers. | Required | 68.0 | | userId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the user to check the permission for. If not specified, the API validates permission for the current user. | Optional | 68.0 | # ConnectApi.InsValidateUserPermissionsRepresentation Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | instructions | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | Human-readable troubleshooting guidance when isValid is false. This property shows how to resolve the user’s missing access privileges, such as which permission set to assign. Omitted or null when the user is permitted. | 68.0 | | isValid | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm "HTML (New Window)") | Indicates whether the user has the required permissions. Returns true when the user meets all necessary org-level and user-level checks to perform the action; otherwise returns false. | 68.0 | # ConnectApi.IPLStandingCalcAmounts Invocable action output representation for insurance policy limit standing calculation amounts. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | initialAmount | Double | Configured amount. | 65.0 | | pendingAmount | Double | Amount that's pending. | 65.0 | | predictedRemainingAmount | Double | Remaining amount to carry forward for the next payment after calculating the pending amount. | 65.0 | | remainingAmount | Double | Remaining amount to carry forward for the next payment. | 65.0 | | totalUsedAmount | Double | Total amount that's used till date. | 65.0 | # ConnectApi.IPLStandingCalcCoverageInfo Output representation for insurance policy limit standing calculation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimCoverageId | String | ID of the related claim coverage. | 65.0 | | claimId | String | ID of the related claim. | 65.0 | | policyAssetId | String | ID of the related policy asset. | 65.0 | | policyCoverageId | String | ID of the related policy coverage. | 65.0 | | policyParticipantId | String | ID of the related policy participant. | 65.0 | | subCoverageName | String | Name of the related sub coverage. | 65.0 | # ConnectApi.IPLStandingCalcLimitAttributes Invocable action output representation for limit attributes. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | applicableActions | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of actions that initiate the attribute processing. | 65.0 | | category | String | Category of the limit. | 65.0 | | durationType | String | Duration type over which the attribute consumption is actively monitored during processing. | 65.0 | | itemType | String | Type of the item. | 65.0 | | policyLimitId | String | ID of the insurance policy limit record. | 65.0 | | policyLimitStandingKey | String | Unique identifier for the insurance policy limit standing. | 65.0 | | scope | String | Scope where the limit is applied. | 65.0 | # ConnectApi.IPLStandingCalcOptions Invocable action input representation for options to calculate standings.
Property Type Description Required or Optional Available Version
shouldIncludePendingAmount Boolean Indicates whether the pending values must be included in the response (true) or not (false)

The default value is false

. 		Optional 65.0
viewOption String Filter values for coverages.

When a claimId is specified in the request, valid values are:

  • showAllPolicyCoverages—Retrieves all policy limits for the root insurance policy and all associated policy coverages. This provides a comprehensive view of all coverage terms.
  • showOpenClaimPolicyCoverages—(Default) Retrieves the policy limits that are associated with the open claim coverages. Additionally, the claim view includes all policy-level and claim-level limits, ensuring visibility into limits that impact the claim, even if no open coverage exists.

When a policyId is specified in the request, valid values are:

  • showAllPolicyCoverages—(Default)Retrieves all policy limit standings, regardless of whether the claim has open coverages. This option provides a full view of the policy's limits without restriction to active claims.
  • showPolicyLevelLimitsOnly—Retrieves policy limit standings at the policy and policy coverage level, but excludes limits that are associated with policy participants or policy assets. Use this option when only high-level policy limits are needed without participant or asset specific details.
Optional 65.0
# ConnectApi.IPLStandingCalcOutputNode Node representation for the Insurance Policy Term Current Standing invocable action node. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | amounts | [ConnectApi.IPLStandingCalcAmounts](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_amount.htm "Invocable action output representation for insurance policy limit standing calculation amounts.") | Details of the calculation amounts. | 65.0 | | coverageInfo | [ConnectApi.IPLStandingCalcCoverageInfo](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_coverage_inf.htm "Output representation for insurance policy limit standing calculation.") | Details of the claim coverage. | 65.0 | | limitAttributes | [ConnectApi.IPLStandingCalcLimitAttributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_limit_attribute.htm "Invocable action output representation for limit attributes.") | Attribute details of the insurance policy limit. | 65.0 | | mappedScopes | [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_map.htm "HTML (New Window)")[ConnectApi.IPLStandingMappedScopes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_mapped_scope.htm "Invocable action output representation for insurance policy limit standing mapped scopes.") | Details of the mapped scopes. | 65.0 | | values | [ConnectApi.IPLStandingCalcValues](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_i_p_l_standing_calc_value.htm "Invocable Action Output representation for IPL Standing Calculation Values") | Calculation values. | 65.0 | # ConnectApi.IPLStandingCalcValues Invocable Action Output representation for IPL Standing Calculation Values | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | initialValue | Integer | Configured value of the limit. | 65.0 | | pendingValue | Integer | Value that's pending. | 65.0 | | predictedRemainingValue | Integer | Remaining value to carry forward for the next payment after calculating the pending value. | 65.0 | | remainingValue | Integer | Remaining value to carry forward for the next payment. | 65.0 | | totalUsedValue | Integer | Total value used till date. | 65.0 | # ConnectApi.IPLStandingMappedScopes Invocable action output representation for insurance policy limit standing mapped scopes. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | parentMappedScopeId | String | ID of the parent product attribute mapped scope that's associated with the product attribute to define parent-child relationship between attribute mappings. | 65.0 | | prodtAttrMappedScopeId | String | ID of the product attribute mapped scope that defines how a product attribute is associated with a specific scope, such as a product type or category. | 65.0 | # ConnectApi.IssuePolicyInputRepresentation Input representation of the request to issue an insurance policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.​AdditionalFieldsMapValue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_map_valu.htm "AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap.")\> | The JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API is generated by the Create Insurance Quote API. | Optional | 63.0 | | billingRecord | [InsurancePolicyBillingInfo​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_billing_info.htm "Input representation for insurance policy billing.") | Details of insurance policy billing. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the quote that’s used to create the policy. | Required | 63.0 | | insurancePolicy | [Insurance​PolicyInput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy.htm "Input representation details of an insurance policy.") | The JSON structure that’s used to create the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [InsurancePolicy​TransactionInput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm "Input representation details of an insurance policy transaction.") | The JSON structure that’s used to override transaction information. | Optional | 63.0 | # ConnectApi.LimitStandingOptionInputRepresentation Input representation for limit standing options. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | shouldIncludePendingAmount | Boolean | Indicates whether the pending amount must be included in the calculated output (true) or not (false). | Optional | 65.0 | | viewOption | String | View options. | Optional | 65.0 | # ConnectApi.MemberPlanFilterInputRepresentation Input representation of the filter that identifies which group census member plan records to process. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | quoteId | String | ID of the quote. The method processes only the member plans whose quote line item belongs to this quote. | Optional | 68.0 | # ConnectApi.MemberPlanInputRepresentation Input representation for an insurance plan that's assigned to a group census member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.GroupbenefitsAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_groupbenefits_attribute.htm "Input representation for an attribute value that overrides the value derived from the product on a group census member plan.")\> | Attribute values that override the values derived from the product for this plan. | Optional | 68.0 | | contractGroupPlanId | String | ID of the ContractGroupPlan record that the member is enrolled in. | Required if you don't specify productCode and rootProductCode. | 68.0 | | groupCensusMemberId | String | ID of the GroupCensusMember record that the plan belongs to. | Optional | 68.0 | | id | String | ID of an existing GroupCensusMemberPlan record. Specify this ID to update an existing plan instead of creating one. | Optional | 68.0 | | name | String | Name of the group census member plan. | Optional | 68.0 | | productCode | String | Product code of the off-contract coverage. | Required if you don't specify contractGroupPlanId. | 68.0 | | rootProductCode | String | Product code of the root product that the off-contract coverage belongs to. | Required if you don't specify contractGroupPlanId. | 68.0 | # ConnectApi.MemberPlanReferenceMappingInputRepresentation Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the contract. The method maps each member plan's quote line item reference to the matching contract group plan in this contract. | Optional | 68.0 | | quoteId | String | ID of the quote. The method maps each member plan's contract group plan reference to the matching quote line item in this quote. | Optional | 68.0 | # ConnectApi.MembersWithPlansInputRepresentation Input representation for adding or updating a family of group census members and their insurance plans. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | duplicateDetectionFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | API names of the fields that are used, along with the default fields, to generate a unique key for identifying duplicate members. The default fields are FirstName, LastName, AssociationWithPrimaryMbr, Email, and GroupCensusId. | Optional | 68.0 | | flowName | String | Name of the flow to use for processing group census member data. The default value is Process Group Census Member Data. | Optional | 68.0 | | members | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.MemberWithPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_with_plans.htm "Input representation for the details of a group census member and the insurance plans to add, update, or remove for that member.")\> | Group census members and their plan details to add or update. | Required | 68.0 | | shouldExecuteConfigurationRule | Boolean | Indicates whether the save flow runs the eligibility and configurator engine when it validates the submitted plans (true) or not (false). When true, the submitted plans are filtered to the plans that the configurator considers eligible. If set to false or not specified, the submitted plans are saved as they are.The default value is false. | Optional | 68.0 | # ConnectApi.MembersWithPlansRepresentation Output representation that's returned when you add or update a family of group census members and their insurance plans. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | Top-level errors that occurred during processing. This property doesn't contain member-specific error details, and it's empty when isSuccess is true. For member-specific errors, see the errors property of each item in members. | 68.0 | | isSuccess | Boolean | Indicates whether the operation completed successfully (true) or not (false). | 68.0 | | members | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.MemberWithPlansRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_member_with_plans.htm "Output representation for an individual group census member and the insurance plans that are added or updated for that member.")\> | Result for each member in the request, including the IDs of the member and the member's plans, and any member-specific errors. | 68.0 | # ConnectApi.MemberWithPlansInputRepresentation Input representation for the details of a group census member and the insurance plans to add, update, or remove for that member. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the person account record of the member. | Optional | 68.0 | | addedPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.MemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan.htm "Input representation for an insurance plan that's assigned to a group census member.")\> | Insurance plans to add to an existing member. | Required to add members. | 68.0 | | additionalFields | [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_map.htm "HTML (New Window)") | Values for custom fields on the GroupCensusMember record, keyed by field API name. | Optional | 68.0 | | annualEligibleSalary | Double | Annual salary of the member that's eligible for benefits calculations. | Optional | 68.0 | | associationWithPrimaryMbr | String | For a dependent, the association to the primary member, such as Spouse or Child. | Optional | 68.0 | | birthdate | String | Date of birth of the member, in YYYY-MM-DD format. | Optional | 68.0 | | city | String | City in the member's address. | Optional | 68.0 | | contactId | String | ID of the contact record of the member. | Optional | 68.0 | | country | String | Country in the member's address. | Optional | 68.0 | | deletedPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the GroupCensusMemberPlan records to remove for this member. | Optional. Use this property only when you update a member. | 68.0 | | dependentCount | Integer | Number of dependents that are associated with the member. | Optional | 68.0 | | email | String | Email address of the member. | Optional | 68.0 | | firstName | String | First name of the member. | Optional | 68.0 | | fullTimeEquivalent | Double | Work capacity of the member, where 1.0 indicates a full-time employee. | Optional | 68.0 | | gender | String | Gender of the member. | Optional | 68.0 | | groupCensusId | String | ID of the GroupCensus record that the member belongs to. | Optional | 68.0 | | groupCensusMemberPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.MemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan.htm "Input representation for an insurance plan that's assigned to a group census member.")\> | Insurance plans to associate with the member. | Optional. Use this property only when you add a member. | 68.0 | | groupClassId | String | ID of the class or category within the group that the member belongs to. | Optional | 68.0 | | groupClassName | String | Name of the group class. | Optional | 68.0 | | grpCensusGrpClassSummaryId | String | ID of the related GroupCensusGroupClassSummary record. | Optional | 68.0 | | id | String | ID of the GroupCensusMember record to update along with its associated insurance plans. | Required when you update a member. Don't specify this ID when you add a member. | 68.0 | | isOptOutAllPlans | Boolean | Indicates whether the member has opted out of all available insurance plans (true) or not (false). | Optional | 68.0 | | isPortalUser | Boolean | Indicates whether a community portal user is created for this member (true) or not (false). | Optional | 68.0 | | joinDate | String | Date that the member joined the group or company. | Optional | 68.0 | | lastname | String | Last name of the member. | Optional | 68.0 | | memberKey | String | Externally defined key that uniquely identifies the member and prevents duplicates. This key is often a concatenation of several field values. | Optional | 68.0 | | memberType | String | Type of member, such as Primary or Dependent. | Optional | 68.0 | | name | String | Full name of the member. This value is saved to the Name field of the GroupCensusMember record. | Required | 68.0 | | optOutPlanTypes | String | Types of plans that the member has opted out of. | Optional | 68.0 | | overrideTypeConfiguration | String | Configuration that governs which plan overrides are permitted for the member, such as Default, Override Attributes, or Override Plans and Attributes. | Optional | 68.0 | | phoneNumber | String | Phone number of the member. | Optional | 68.0 | | policyStartDate | String | Date that the member's policy coverage begins. | Optional | 68.0 | | postalCode | String | Postal code or ZIP code in the member's address. | Optional | 68.0 | | primaryGroupCensusMemberId | String | ID of the primary GroupCensusMember record that the dependents are associated with. | Optional | 68.0 | | primaryMemberCategory | String | Category of the primary member. | Optional | 68.0 | | primaryMemberSource | String | System or source that the member's data originated from. | Optional | 68.0 | | relationshipToPrimaryMember | String | Member's relationship to the primary insured. | Optional | 68.0 | | smokerStatus | String | Smoking status of the member, such as Smoker or Non-smoker. | Optional | 68.0 | | sourceSystemIdentifier | String | ID of the member in an external source system. Use this ID for integration purposes. | Optional | 68.0 | | state | String | State or province in the member's address. | Optional | 68.0 | | status | String | Current status of the member, such as Active or Inactive. | Optional | 68.0 | | street | String | Street in the member's address. | Optional | 68.0 | | upsertedPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.MemberPlanInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_member_plan.htm "Input representation for an insurance plan that's assigned to a group census member.")\> | Insurance plans to add or update for an existing member. | Optional. Use this property only when you update a member. | 68.0 | # ConnectApi.MemberWithPlansRepresentation Output representation for an individual group census member and the insurance plans that are added or updated for that member. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | List<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)")\> | Errors that occurred while this member or the member's plans were created or updated. | 68.0 | | memberId | String | ID of the GroupCensusMember record that's created or updated. | 68.0 | | memberPlans | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the GroupCensusMemberPlan records that are associated with the member. | 68.0 | # ConnectApi.OpenClaimCoverageInputRep Input representation for the open claim coverage action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm "Input representation for the details of the additional field.")\> | Additional standard or custom fields to open the claim coverage. | Optional | 65.0 | | claimId | String | ID of the claim record. | Required | 65.0 | | claimItemId | String | ID of the claim item. | Required | 65.0 | | claimParticipantId | String | ID of the claim participant that's associated with the claim coverage. | Required | 65.0 | | currencyIsoCode | String | Currency ISO code for reserve adjustments. | Optional | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | insurancePolicyAssetId | String | ID of the asset covered by the insurance policy that's associated with the claim coverage. | Optional | 65.0 | | insurancePolicyCoverageId | String | ID of the insurance policy coverage. | Optional | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | | name | String | Name of the claim coverage. | Optional | 65.0 | | reserveProcessingMode | String | Determines how financial reserves are handled when a claim coverage is created. | Optional | 65.0 | # ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation Input representation of the details to perform an out-of-sequence endorsement on an insurance policy.
Property Type Description Required or Optional Available Version
contextId String ID of the context that's used to create an endorsement policy version. Required 65.0
effectiveDate String Date from which the out-of-sequence endorsement applies. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the endorsement applies starting March 1, 2025, and the API re-rates the policy from 2025-03-01 forward.

 Required 65.0
fieldSetIds AdditionalFields​FieldSet​Input​Representation Field set IDs of the additional fields that are associated with the insurance policy. Optional 65.0
insurancePolicy InsurancePolicy​Input​Representation Details of the insurance policy to create the out-of-sequence endorsement for. Optional 65.0
transactionRecord InsurancePolicy​TransactionInput​Representation JSON structure that's used to override the transaction information. Optional 65.0
# ConnectApi.OutOfSequenceEndorsePolicyOutputRepresentation Output representation for out of sequence endorsement output representation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | error | [ConnectApi.ErrorOutput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm "Output representation details of the error encountered while processing the request.") | List of errors when the out-of-sequence endorsement operation fails. | 65.0 | | jobIdentifier | String | ID of the job that's created for the out-of-sequence endorsement process. | 65.0 | # ConnectApi.OutOfSequencePolicyEndorsementInputRep Input representation of the details to perform an out-of-sequence endorsement on an insurance policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context that's used to create an endorsement policy version. | Required | 65.0 | | effectiveDate | String | Date on which the out of sequence endorsement operation happens. | Required | 65.0 | | fieldSetIds | [FieldSetIdsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_field_set_ids_input_re.htm "List of the field set IDs for asset, coverage, participant, and policy objects.") | Field set IDs of the additional fields that are associated with the insurance policy. | Optional | 65.0 | | insurancePolicy | [InsPolicyIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_i_a_input_re.htm "Input representation details of an insurance policy.") | Details of the insurance policy to create the out-of-sequence endorsement for. | Optional | 65.0 | | policyId | String | ID of the insurance policy to create the out-of-sequence endorsement for. | Required | 65.0 | | transactionRecord | [InsPolicyTrxnIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_trxn_i_a_input_re.htm "Input representation details of an insurance policy transaction.") | JSON structure that's used to override the transaction information. | Optional | 65.0 | # ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation Input representation for paying a claim coverage payment detail. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_coverage_payment_detail_options.htm "Optional toggles that control which pre-payment checks run for a claim coverage payment detail.") | Optional toggles that control which pre-payment checks run. | Optional | 68.0 | # ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep Optional toggles that control which pre-payment checks run for a claim coverage payment detail. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | shouldCheckFinancialAuthority | Boolean | Indicates whether the user financial authority (UFA) check runs before payment (true) or not (false). | Optional | 68.0 | | shouldVerifyReserveLimit | Boolean | Indicates whether the reserve-limit check runs before payment (true) or not (false). | Optional | 68.0 | # ConnectApi.PayClaimCoveragePaymentDetailRep Output representation for a claim coverage payment detail operation. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimPaymentSummaryId | String | ID of the claim payment summary record that’s added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim. | 66.0 | | consumedLimitCount | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | 66.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the API request. | 65.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | 68.0 | | insPolicyLimitTrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the insurance policy limit tracking records that are created during the payment process. | 66.0 | | isFinancialAuthorityConfigured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | paidAmount | Double | Total amount that’s paid. | 66.0 | | remainingReserves | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.RemainingReserveRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\> | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | 68.0 | | warnings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | 68.0 | # ConnectApi.PayClaimCvrPymtDtlInputRep Input representation for the Pay Claim Coverage Payment Detail action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim. | Required | 65.0 | | coverageId | String | ID of the claim coverage. | Required | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail to pay. | Required | 65.0 | | shouldCheckFinancialAuthority | Boolean | Indicates whether the user financial authority (UFA) check runs before payment (true) or not (false). The default is false (the check is skipped). | Optional | 68.0 | | shouldVerifyReserveLimit | Boolean | Indicates whether the reserve-limit check runs before payment (true) or not (false). The default is false (the check is skipped). | Optional | 68.0 | # ConnectApi.PayClaimCvrPymtDtlOutputRep Output representation for the Pay Claim Coverage Payment Detail action. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimPaymentSummaryId | String | ID of the claim payment summary record that's added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim. | 66.0 | | consumedLimitCount | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | 66.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | 68.0 | | insPolicyLimitTrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the insurance policy limit tracking records that are created during the payment process. | 66.0 | | isFinancialAuthorityConfigured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 65.0 | | paidAmount | Double | Total amount that's paid. | 66.0 | | remainingReserves | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.RemainingReserveOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve_output.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\> | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | 68.0 | | warnings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | 68.0 | # ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep Input representation for the ex gratia payment for the claim coverage payment detail. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_coverage_payment_detail_options.htm "Optional toggles that control which pre-payment checks run for a claim coverage payment detail.") | Optional toggles that control which pre-payment checks run. | Optional | 68.0 | | reason | String | Reason for the ex gratia payment. | Optional | 66.0 | # ConnectApi.PayExGratiaClaimCvrPaymentDetailRep Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimPaymentSummaryId | String | ID of the claim payment summary record that’s added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim. | 66.0 | | consumedLimitCount | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | 66.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Error details that are shown when the API operation fails. | 66.0 | | exceededAmount | Double | Excess amount that’s paid above the limits. | 66.0 | | exceededCount | Integer | Number of coverage units or counts that are paid above the policy limits. This occurs when payments exceed the allowable limits, such as in discretionary ex gratia payments. | 66.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | 68.0 | | insPolicyLimitTrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the insurance policy limit tracking records that are created during the ex gratia payment process. | 66.0 | | isFinancialAuthorityConfigured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 66.0 | | paidAmount | Double | Total amount that’s paid towards ex gratia. | 66.0 | | remainingReserves | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.RemainingReserveRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\> | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | 68.0 | | warnings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | 68.0 | # ConnectApi.PayExGratiaClaimCvrPymtDtlInputRep Input representation for the Pay Ex Gratia Claim Coverage Payment Detail action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim. | Required | 66.0 | | coverageId | String | ID of the claim coverage. | Required | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail to pay. | Required | 66.0 | | reason | String | Reason for the ex gratia payment. | Optional | 66.0 | | shouldCheckFinancialAuthority | Boolean | Indicates whether the user financial authority (UFA) check runs before payment (true) or not (false). The default is false (the check is skipped). | Optional | 68.0 | | shouldVerifyReserveLimit | Boolean | Indicates whether the reserve-limit check runs before payment (true) or not (false). The default is false (the check is skipped). | Optional | 68.0 | # ConnectApi.PayExGratiaClaimCvrPymtDtlRep Output representation for the Pay Ex Gratia Claim Coverage Payment Detail action. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | claimPaymentSummaryId | String | ID of the claim payment summary record that's added or updated. | 66.0 | | consumedLimitCount | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | 66.0 | | exceededAmount | Double | Excess amount that's paid above the limits. | 66.0 | | exceededCount | Integer | Number of coverage units or counts that are paid above the policy limits. | 66.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). | 68.0 | | insPolicyLimitTrackingIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | IDs of the insurance policy limit tracking records that are created during the ex gratia payment process. | 66.0 | | isFinancialAuthorityConfigured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | 66.0 | | paidAmount | Double | Total amount that's paid towards ex gratia. | 66.0 | | remainingReserves | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.RemainingReserveOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_remaining_reserve_output.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\> | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | 68.0 | | warnings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | 68.0 | # ConnectApi.PolicyAsyncRepresentation Output representation for multi-root policy renewal asynchronous operations. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | error | [ConnectApi.ErrorOutput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm "Output representation details of the error encountered while processing the request.") | List of errors that occurred during the processing of the API request. | 66.0 | | jobIdentifier | String | ID of the asynchronous job that's generated to process the multi-root policy. | 66.0 | # ConnectApi.PolicyOutputRepresentation Output representation of the policy details. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | error | [ConnectApi.Error​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_output.htm "Output representation details of the error encountered while processing the request.") | List of errors encountered during the processing of the API request. | 63.0 | | originalPolicyId | String | ID of the original policy. | 63.0 | | policyId | String | ID of the issued or endorsed policy. | 63.0 | # ConnectApi.PortalUserCreationInputRepresentation Input representation containing the details for creating a portal user. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | emailEncodingKey | String | Email encoding for the user, such as UTF-8 or ISO-8859-1. | Required | 65.0 | | languageLocaleKey | String | Language for the user, such as en\_US for U.S. English. | Required | 65.0 | | localeSidKey | String | Locale for the user, which affects the format of dates, times, and numbers. | Required | 65.0 | | profileId | String | ID of the profile to assign to the new portal user. | Required | 65.0 | | timeZoneSidKey | String | Time zone for the user, such as America or Los\_Angeles. | Required | 65.0 | # ConnectApi.PremiumPreviewAmountsRepresentation Output representation of the rolled-up standard and term premium amounts for a single policy-hierarchy node. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | standardCommission | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Standard commission amount for the node. | 68.0 | | standardFee | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Standard fee amount for the node. | 68.0 | | standardPremium | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Standard premium amount for the node. | 68.0 | | standardTax | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Standard tax amount for the node. | 68.0 | | termCommission | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Term commission amount for the node; day-based proration of standard where applicable. | 68.0 | | termFee | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Term fee amount for the node. | 68.0 | | termPremium | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Term premium amount for the node. | 68.0 | | termTax | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Term tax amount for the node. | 68.0 | | totalStandard | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Total standard amount, including premium, tax, and fee. For surcharge nodes, only this field and totalTerm are populated; the component fields are null. | 68.0 | | totalTerm | [Double](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_double.htm "HTML (New Window)") | Total term amount, including premium, tax, and fee. For surcharge nodes, only this field and totalStandard are populated; the component fields are null. | 68.0 | # ConnectApi.PremiumPreviewInputRep Input representation for a draft-state premium preview. Specify hierarchy-node references to compute, or leave the list empty to return only the policy-root amounts. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | references | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.PremiumPreviewReferenceRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_premium_preview_reference_rep.htm "Input representation of a reference to a node in the insurance policy hierarchy whose rolled-up premium amounts you want to preview.")\> | List of hierarchy-node references to compute. Supports up to 2000 records. If omitted or empty, only the policy-level (root) rolled-up amounts are returned. Results are returned in the same order as this list. | Optional | 68.0 | # ConnectApi.PremiumPreviewReferenceRep Input representation of a reference to a node in the insurance policy hierarchy whose rolled-up premium amounts you want to preview. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the policy-hierarchy node to compute. Valid node types include InsurancePolicy, InsurancePolicyAsset, InsurancePolicyParticipant, InsurancePolicyCoverage, and surcharge nodes that belong to the policy named by policyId. | Required | 68.0 | # ConnectApi.PremiumPreviewRepresentation Output representation of a draft-state premium preview, including the policy ID and per-node rolled-up amount results. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html)\> | Error details for the entire request. For example, record not found, batch-limit, or proration failures. Shows null when the request succeeds. Request-level failures can also show ConnectApi.ConnectApiException. | 68.0 | | policyId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the insurance policy the preview was computed for. | 68.0 | | results | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.PremiumPreviewResultRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview_result.htm "Output representation of per-node result from a draft-state premium preview, including rolled-up amounts or per-node errors.")\> | Per-node computed results, in request order. When references aren't specified, this list contains a single entry for the policy root. There are no top-level total fields on this representation. | 68.0 | # ConnectApi.PremiumPreviewResultRepresentation Output representation of per-node result from a draft-state premium preview, including rolled-up amounts or per-node errors. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | amounts | [ConnectApi.PremiumPreview​AmountsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview_amounts.htm "Output representation of the rolled-up standard and term premium amounts for a single policy-hierarchy node.") | Rolled-up premium amounts for this hierarchy node. Shows null when errors are populated for the node. | 68.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorResponseRepresentation](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html)\> | Per-node errors. For example, INVALID\_API\_INPUT when the reference isn’t in the policy hierarchy. Shows null when the node computed successfully. A failed reference doesn’t fail the whole request. | 68.0 | | recordId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm "HTML (New Window)") | ID of the hierarchy node the amounts or errors belong to. | 68.0 | # ConnectApi.ProcessPolicyLimitsInputRepresentation Input representation for processing policy limits for a claim loss item.
Property Type Description Required or Optional Available Version
adjustedAmount Double Amount after adjustments are made based on the current standings of the policy limits. Optional 65.0
benefitName String Name of the specific benefit or sub-coverage that the loss item applies to. Optional 65.0
limitUnitCount Integer Unit count that the payment detail represents.

Default value is 1.

 Optional 65.0
paymentDetailId Integer ID of the claim coverage payment detail record that’s associated with the loss item. Optional 67.0
# ConnectApi.ProcessPolicyLimitsRepresentation Output representation for processing the policy limits for a claim loss item. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Details of the errors that are associated with the processing of the API request. | 65.0 | | exceededAmount | Double | Amount that exceeds the remaining available policy limit in the specified limit currency. | 66.0 | | exceededCount | Integer | Count of coverage units beyond the policy’s allowed unit limit. | 66.0 | | insPolicyLimitTrackings | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.InsPolicyLimitTrackingDetailsRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_limit_tracking_details.htm "Output representation for the insurance policy limit tracking details.")\> | List of insurance policy limit tracking details. | 65.0 | | isLimitExceeded | Boolean | Indicates whether a limit is exceeded (true) or not (false). | 65.0 | # ConnectApi.RecalculateAdjustmentsInputRep Input representation for recalculating the adjustments for existing payment details. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to recalculate the adjusted amount for a claim coverage payment detail record. | Optional | 67.0 | | claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Optional | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail for recalculating adjustments. | Optional | 66.0 | # ConnectApi.RefundOutputRepresentation Output representation of the refund payment. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | fee | Double | Refund fee amount after cancellation. | 63.0 | | premium | Double | Refund premium amount after cancellation. | 63.0 | | tax | Double | Refund tax amount after cancellation. | 63.0 | # ConnectApi.ReinstatePolicyInputRep Input representation for the Reinstate Insurance Policy Invocable Action.
Property Type Description Required or Optional Available Version
additionalInput List<ConnectApi.InsPolicy​AddlInput​IARep> JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalInput take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional input. Optional 65.0
billingRecord InsurancePolicyBillingInfo​InputRepresentation Insurance policy billing information. Required if Career Billing is enabled in your org 67.0
effectiveDate String Date from when the policy is reinstated.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the reinstatement applies starting March 1, 2025.

 Optional 65.0
insurancePolicy InsPolicyIA​InputRep Details of the insurance policy. Optional 65.0
policyId String ID of the canceled insurance policy to be reinstated. Required 65.0
transactionRecord InsPolicyTrxn​IAInputRep JSON structure that's used to override the transaction information. Optional 65.0
# ConnectApi.ReinstatePolicyInputRepresentation Input representation for reinstating an insurance policy.
Property Type Description Required or Optional Available Version
additionalFields List<ConnectApi.Additional​FieldsMapValue> JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. Optional 65.0
billingRecord InsurancePolicyBillingInfo​InputRepresentation Insurance policy billing information. Required if Career Billing is enabled in your org 67.0
effectiveDate String Date from which the policy reinstatement becomes effective. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the reinstatement applies starting March 1, 2025.

 Optional 65.0
insurancePolicy InsurancePolicy​InputRepresentation Details of the insurance policy. Optional 65.0
transactionRecord InsurancePolicy​Transaction​InputRepresentation JSON structure that's used to override the transaction information. Optional 65.0
# ConnectApi.RemainingReserveOutputRep Output representation for the remaining reserve amount and scope after the payment is processed. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | remainingReserveAmount | Double | Reserve amount remaining after the payment is processed. | 68.0 | | reserveLimitRecordId | String | ID of the claim financial reserve limit record associated with a setup-time reserve. Shows null for a runtime reserve. | 68.0 | | scope | String | Scope of the reserve. For a setup-time reserve, the value is Org or Product. For a runtime reserve, the value is Claim or ClaimCoverage. | 68.0 | # ConnectApi.RemainingReserveRep Output representation for the remaining reserve amount and scope after the payment is processed. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | remainingReserveAmount | Double | Reserve amount remaining after the payment is processed. | 68.0 | | reserveLimitRecordId | String | ID of the claim financial reserve limit record associated with a setup-time reserve. Shows null for a runtime reserve. | 68.0 | | scope | String | Scope of the reserve. For a setup-time reserve, the value is Org or Product. For a runtime reserve, the value is Claim or ClaimCoverage. | 68.0 | # ConnectApi.RenewInsurancePoliciesIAInputRep An Apex ConnectApi.RenewInsurancePoliciesIAInputRep record that contains the details of the insurance policies to be renewed. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | execute​ConfigurationRules | Boolean | Indicates whether the configuration rules for renewal must be executed (true) or not (false). | Optional | 64.0 | | execute​Pricing | Boolean | indicates whether to execute pricing during the policy renewal process (true) or not (false). The default value is true. | Optional | 67.0 | | execute​QualificationRules | Boolean | Indicates whether the qualification rules for renewal must be executed (true) or not (false). | Required for quote renewals. | 64.0 | | fieldSetIds | [Field​SetIdsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_field_set_ids_input_re.htm "List of the field set IDs for asset, coverage, participant, and policy objects.") | Input representation of field set IDs. | Optional | 64.0 | | flow​APINameWithNamespace | String | The API name of the flow to execute changes before each policy or quote renewal process. Include the namespace prefix, if any. | Optional | 64.0 | | issueQuote | Boolean | Indicates whether the renewal quote must be issued (true) or not (false). | Optional | 64.0 | | jobIdentifier | String | A unique ID of the batch job that's used to monitor and generate reports using Custom Report Type. The maximum length is 50 characters. | Required | 64.0 | | policyId | String | ID of the insurance policy to be renewed. | Required | 64.0 | | priceBookId | String | ID of the price book that's used to renew policies. Defaults to the Standard Price Book record ID if no value is provided. | Required for quote renewals. | 64.0 | | product​SellingModel | String | The model that's used to offer the product, such as one-time or term-based. The default is one-time if no value is provided. | Required for quote renewals. | 64.0 | | sameTenure | Boolean | Indicates whether the same tenure must be set for renewal as original policy (true) or not (false). | Optional | 64.0 | # ConnectApi.RenewPolicyInputRepresentation Input representation of the request to renew a policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.​AdditionalFieldsMapValue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_additional_fields_map_valu.htm "AdditionalFieldsMapValue wrapper object for use as child wrapper of AdditionalFieldsMap.")\> | The JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [InsurancePolicyBillingInfo​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_billing_info.htm "Input representation for insurance policy billing.") | Insurance policy billing information. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the quote that's used to renew the policy. | Required | 63.0 | | insurancePolicy | [InsurancePolicy​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy.htm "Input representation details of an insurance policy.") | The JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [InsurancePolicy​TransactionInput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_transaction.htm "Input representation details of an insurance policy transaction.") | The JSON structure that's used to override the transaction information. | Optional | 63.0 | # ConnectApi.UpdateClaimCoverageInputRep Input representation for the update claim coverage action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)") | Additional standard or custom fields to update the record. | Optional | 65.0 | | claimId | String | ID of the claim. | Required | 65.0 | | coverageId | String | ID of the coverage within the claim. | Required | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | # ConnectApi.UpdateClaimCoverageInputRepresentation Input representation for updating a claim coverage. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Object | Additional fields for the coverage. | Optional | 65.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 65.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 65.0 | # ConnectApi.UpdateClaimInputRepresentation Invocable action input representation for the update claim action. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the account that's associated with the claim. | Optional | 65.0 | | additionalFields | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAdditionalFieldInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_additional_field_input_re.htm "Input representation for the details of the additional field.")\> | Additional standard or custom fields that are used to create or update insurance claim. | Optional | 65.0 | | attributes | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimAttributeInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_attribute_input_re.htm "Invocable action input representation for claim attributes.")\> | Attributes of the claim product. | Optional | 65.0 | | claimId | String | ID of the claim. | Required | 65.0 | | claimReason | String | Reason for the claim. | Optional | 65.0 | | claimReasonType | String | Category that the claim reason belongs to. | Optional | 65.0 | | claimType | String | Type of claim. | Optional | 65.0 | | expenseReserveAdjustmentReason | String | Reason for the expense reserve adjustment. | Optional | 68.0 | | expenseReserveAmount | Double | Amount that's reserved to cover potential expenses while handling the claim, such as administrative or legal costs. | Optional | 68.0 | | insurancePolicyId | String | ID of the insurance policy on which the claim is raised. | Optional | 65.0 | | items | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimItemInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_item_input_re.htm "Invocable action input representation for claim item.")\> | Details of the items that are associated with the claim. | Optional | 65.0 | | lossDate | String | Date on which the loss occurred. | Optional | 65.0 | | lossReserveAdjustmentReason | String | Reason for the loss reserve adjustment. | Optional | 68.0 | | lossReserveAmount | Double | Amount that's reserved to cover a potential payment for a loss. | Optional | 68.0 | | lossType | String | Type of the loss for which the claim is initiated. | Optional | 65.0 | | name | String | Name of the claim. | Optional | 65.0 | | options | [ClaimOptionsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_options_input_re.htm "Invocable action input representation for claim options") | Options for creating or updating a claim. | Optional | 65.0 | | participants | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ClaimParticipantInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim_participant_input_re.htm "Invocable Action Input representation for Claim Participant")\> | Claim participants that are associated with the claim. | Optional | 65.0 | | productCode | String | Product code of the claim product. | Optional | 65.0 | # ConnectApi.VerifyPolicyCoverageInputRep Invocable action input representation details to verify the coverage of a specific insurance policy. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | coverageId | String | Insurance policy coverage ID. | Required | 65.0 | | insuredAssetOrParticipantId | String | ID of the insured asset or participant that's related to the policy coverage. | Optional | 65.0 | | lossDate | String | Date on which the incident occurred. | Optional | 65.0 | | policyId | String | ID of the insurance policy. | Required | 65.0 | # ConnectApi.VerifyPolicyCoverageInputRepresentation Input representation for verifying a policy coverage's applicability for a specified loss date. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insuredAssetOrParticipantId | String | ID of the insured asset or participant that's related to the policy coverage. | Optional | 65.0 | | lossDate | String | Date on which the incident occurred. | Optional | 65.0 | # ConnectApi.VerifyPolicyCoverageOutputRep Invocable action output representation for verify policy coverage. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_System_List_get.htm "HTML (New Window)")<[ConnectApi.ErrorDetailOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | List of errors that are encountered during the API operation. | 65.0 | | isSuccess | Boolean | Indicates whether the policy coverage is valid for the date on which the incident occurred (true) or not (false). | 65.0 | # ConnectApi.VerifyPolicyCoverageRepresentation Output representation of a policy coverage's applicability for a specified loss date. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm "HTML (New Window)")<[ConnectApi.ErrorDetail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_error_detail.htm "Output representation of an error.")\> | Errors that are encountered during the processing of the API request. | 65.0 | | isSuccess | Boolean | Indicates whether the policy coverage is valid for the date on which the incident occurred (true) or not (false). | 65.0 | # Context JSON Output representation for the context JSON. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | salesTransactions | [Insurance Sales Transaction](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_output.htm "Output representation for the insurance sales transaction.")\[\] | List of JSON representations for the context node. | Small, 66.0 | 66.0 | # Contract Creation Input Input representation for creating group benefits contract. ## JSON Example { "quoteId": "0Q0SG000000DQA00AO", "contractStartDate": "2025-03-11", "contractEndDate": "2026-03-11", "enrollmentStartDate": "2025-01-01", "enrollmentEndDate": "2025-02-01", "contractTerm": 1, "additionalFields": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "CustomerSignedTitle", "value": "Mr" } \] } }, { "entity": "ContractGroupPlan", "instanceKey": "d5861be1-9920-42d9-8f43-093b0a709d35", "fields": { "data": \[ { "key": "EligibilityCriteria", "value": "testcriteria" } \] } } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Contract Item](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_contract_item.htm "Input representation for additional fields to be added to contract items.")\[\] | List of additional fields to add to contract items. | Optional | 65.0 | | contractEndDate | String | End date of the contract. | Required | 65.0 | | contractStartDate | String | Start date of the contract. | Required | 65.0 | | contractTerm | Integer | Contract terms in months. | Optional | 65.0 | | enrollmentEndDate | String | End date for plan enrollment. | Optional | 65.0 | | enrollmentStartDate | String | Start date for plan enrollment. | Optional | 65.0 | | quoteId | String | ID of the quote to create the contract from. | Required | 65.0 | # Contract Creation Response Output representation of the group benefits Quote-to-Contract process. ## JSON Example { "errors": \[\], "isSuccess": true, "message": "Contract creation process has been initiated.", "requestId": "707p00000004C9wAAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [ConnectApi.ErrorResponse](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | List of errors that occurred during processing. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the contract creation is successfully initiated (true) or not (false). | Small, 65.0 | 65.0 | | message | String | Status message for the contract creation process. | Small, 65.0 | 65.0 | | requestId | String | ID of the asynchronous bulk request job. | Small, 65.0 | 65.0 | # Contract Endorsement Response Output representation of the details when an endorsed contract version is created from a quote. ## JSON Example { "errors": \[\], "isSuccess": true, "message": "Contract was created from the quote", "contractId": "800xx0000004C92AAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the endorsed contract that's created. | Small, 68.0 | 68.0 | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while endorsing the contract. Empty when the request succeeds. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the endorsed contract is created successfully (true) or not (false). | Small, 68.0 | 68.0 | | message | String | Status message for the contract endorsement request. | Small, 68.0 | 68.0 | # Contract Item Input representation for additional fields to be added to contract items. ## JSON Example { "entity": "ContractGroupPlan", "fields": \[ { "key": "CustomField\_\_c", "value": "CustomValue" } \], "instanceKey": "d5861be1-9920-42d9-8f43-093b0a709d35" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | API name of the entity to add fields to, such as ContractGroupPlan. | Optional | 65.0 | | fields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | List of key-value pairs that represent the fields and their values for the entity. | Optional | 65.0 | | instanceKey | String | Unique instance key of the Quote Line Item. | Optional | 65.0 | # Contract Lifecycle Management Issue, endorse, and renew group benefits contracts. - **[Endorse Contract Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_contract.htm)** Create an endorsed contract version from an existing contract based on the quote for mid-term adjustments. - **[Create Contract From Quote Synchronous Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_contract.htm)** Issue a group insurance contract from a quote, creating both the contract and insurance contract records with the full contract group plan hierarchy, including their plan attributes and group class attributes. - **[Create Contract From Quote Asynchronous Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_contract_from_quote.htm)** Asynchronously create a group insurance contract from a quote. - **[Renew Contract Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_contract.htm)** Renew a group insurance contract by creating a new contract for the next term from a renewal quote, carrying forward the relevant contract details and line items. # Contract Lifecycle Management Issue, endorse, and renew group benefits contracts. - **[Endorse Contract (POST)](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. - **[Issue Contract From Quote (POST)](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. - **[Issue Contract From Quote Asynchronous (POST)](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. - **[Renew Contract (POST)](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. # Contract Renewal Response Output representation of the details when a renewed group benefits contract is created from a quote. ## JSON Example { "errors": \[\], "isSuccess": true, "message": "Contract was created from the quote", "contractId": "800xx0000004C92AAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the renewed contract that's created. | Small, 68.0 | 68.0 | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while renewing the contract. Empty when the request succeeds. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the renewed contract is created successfully (true) or not (false). | Small, 68.0 | 68.0 | | message | String | Status message for the contract renewal request. | Small, 68.0 | 68.0 | # Cost Calculation Output representation details of the cost calculation. ## JSON Example Here's a sample success response. { "isSuccess":true, "errors":\[\], "policy": { "id": "p111", "premiumAmountWithFrequency": { "Annually": "xxx.xx", "Monthly": "xxx.xxx", "Quarterly": "xx.xxx" }, "premiumEqvAmountWithFrequency": { "Annually": "xx.xx", "Monthly": "xx.xx", "Quarterly": "xxx.xxx" }, "feeAmountWithFrequency": { "Annually": "xx.xx", "Monthly": "xx.xx", "Quarterly": "xxx.xxx" }, "coverages": \[ { "id": "pc111", "premiumAmountWithFrequency": { "Annually": "xxx.xx", "Monthly": "xxx.xxx", "Quarterly": "xx.xxx" }, "premiumEqvAmountWithFrequency": { "Annually": "xx.xx", "Monthly": "xx.xx", "Quarterly": "xxx.xxx" }, "feeAmountWithFrequency": { "Annually": "xx.xx", "Monthly": "xx.xx", "Quarterly": "xxx.xxx" }, "ratePlans": \[ { "id": "rp11", "totalPremiumAmount": 350, "totalFeeAmount": "xyz", "totalPremiumEqvAmount": "xyz", "ratePlanLineItems": \[ { "id": "rpli111", "premiumAmount": 100 }, { "id": "rpli112", "premiumAmount": 150 } \] }, { "id": "rp12", "totalPremiumAmount": 580, "ratePlanLineItems": \[ { "id": "rpli121", "premiumAmount": 80 }, { "id": "rpli122", "premiumAmount": 200 }, { "id": "rpli123", "premiumAmount": 300 } \] } \] } \] } } This request shows a sample error response. { "isSuccess":true, "errors" : \[ { "code":"INVALID\_INPUT", "message": "Specify a valid ratePlanId." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Small, 63.0 | 63.0 | | policy | Map | Map of policy and cost calculation details from policy to ratePlanLineItems. | Small, 63.0 | 63.0 | # Cost Calculation (PATCH) Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. The InsuranceRatePlanLineItem premium, fees, or premium equivalent amount is rolled up to the Insurance Rate Plan, Insurance Coverage, and Insurance Policy Premium Amount. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/expected-rates ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTSG0000000o9h4AA/expected-rates?businessSObjectType=InsuranceRatePlan&recordId=1CcSG00000000fx0AA ## Available Version 63.0 ## HTTP Methods PATCH ## Path Parameter for PATCH | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of parent policy for which the expected cost is calculated. | Required | 63.0 | ## Request Parameters for PATCH
Parameter Name Type Description Required or Optional Available Version
businessSObjectType String Name of business SObject to calculate the premium for. Possible values are:
  • InsurancePolicy
  • InsurancePolicyCoverage
  • InsuranceRatePlan
  • InsuranceRatePlanLineItem
Optional 63.0
recordId String ID of business SObject to calculate the premium for. Optional 63.0
## Request Body for PATCH ### JSON Example { "action": "rollup", "expressionSetName": "expressionSetName", "ratePlanLineItems": \[ { "id": "xxxxxx", "rate": 100, "enrollmentCount": 1000, "custom\_field\_1": "xxxxxx" }, { "id": "yyyyy", "rate": 50, "enrollmentCount": 200, "custom\_field\_1": "xxxxxx" } \] } ### Properties
Name Type Description Required or Optional Available Version
action String Action for processing RatePlanLineItems. Valid values are:
  • rollup: Calculates premium and roll ups it to Insurance Policy level.
  • calculate: Calculates premium and returns it in the output.
Optional 63.0
expressionSet​Name String Name of the expression set for cost calculation. If not specified, the value from the InsPolicyManagementConfig setup object is taken. Optional 63.0
ratePlan​LineItems List<Map<String, Object>> List of insurance rate plan line items to include for calculation. Items with an id represent existing records. Items without an id are draft records. When action is calculate, premiums for draft records are calculated and returned without being saved. Use referenceId to correlate draft records with their calculated premiums in the response. Optional 63.0
## Response Body for PATCH [Cost Calculation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cost_calculation_output.htm "Output representation details of the cost calculation.") # Cost Calculation Input Input representation of the request to calculate brokerage cost. ## JSON Example { "action": "rollup", "expressionSetName": "expressionSetName", "ratePlanLineItems": \[ { "id": "xxxxxx", "rate": 100, "enrollmentCount": 1000, "custom\_field\_1": "xxxxxx" }, { "id": "yyyyy", "rate": 50, "enrollmentCount": 200, "custom\_field\_1": "xxxxxx" } \] } ## Properties
Name Type Description Required or Optional Available Version
action String Action for processing RatePlanLineItems. Valid values are:
  • rollup: Calculates premium and roll ups it to Insurance Policy level.
  • calculate: Calculates premium and returns it in the output.
Optional 63.0
expressionSet​Name String Name of the expression set for cost calculation. If not specified, the value from the InsPolicyManagementConfig setup object is taken. Optional 63.0
ratePlan​LineItems List<Map<String, Object>> List of insurance rate plan line items to include for calculation. Items with an id represent existing records. Items without an id are draft records. When action is calculate, premiums for draft records are calculated and returned without being saved. Use referenceId to correlate draft records with their calculated premiums in the response. Optional 63.0
# Create and Manage Insurance Policies by Using Salesforce Quoting Learn how to effectively use the Insurance Policy and Quoting Connect APIs, along with the associated invocable actions, to build comprehensive user journeys by using Salesforce Flows and Omniscripts. The Salesforce Insurance Policy and Quoting APIs, and the related invocable actions provide a complete set of tools to manage the entire insurance policy lifecycle. These APIs support key policy administration processes, such as policy issuance, endorsement, renewal, and cancellation. By using these APIs and invocable actions, you can create user journeys for insurance representatives who use the Salesforce console, as well as the policyholders and partners who access the services through community portals. - **[Endorse Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/endorse_policy_using_quote.htm)** Policy endorsement, also known as Mid-Term Adjustment (MTA), is the process of making modifications to an active insurance policy during its term. Common modifications include adding or removing coverage, or updating policy attributes, such as limits and deductibles. Endorsements usually affect the policy price and create a new policy version instead of updating the existing record. This new version includes the applied changes, along with a recalculated standard premium. It also contains a prorated term premium that’s calculated based on the effective date of the endorsement. - **[Issue Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/issue_policy_using_quote.htm)** The policy issuance process begins after the policyholder accepts the quote provided by the insurance company. - **[Renew Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/renew_policy_using_quote.htm)** Policy renewal is the process of extending insurance coverage for an additional policy term, typically as the current policy approaches its effective-to date. A key part of renewal is that a renewed policy creates a new policy record. - **[Create Out of Sequence Policy Endorsement](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/out_of_sequence_policy_endorsement_using_quote.htm)** Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction. - **[Issue Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/issue_multi_root_policy_using_quote.htm)** The policy issuance process begins after the policyholder accepts the quote provided by the insurance company. This process creates a parent–child insurance policy structure in which a parent policy serves as a lifecycle container for one or more insured child policies. - **[Endorse Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/endorse_multi_root_policy_using_quote.htm)** Modifies an active multi-root insurance policy by creating new versions of the parent policy and all child policies, regardless of which child policy is changed. The resulting policy versions include recalculated standard and prorated premiums based on the endorsement effective date. - **[Renew Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/renew_multi_root_policy_using_quote.htm)** Renew a multi-root policy to create a new policy term for the parent policy and all associated child policies. The parent–child policy structure is preserved in the renewed term. # Create and Manage Insurance Policies Without Using Salesforce Quoting Learn how to use the Insurance Policy APIs and invocable actions to manage the policy lifecycle when Salesforce quoting isn't used, or when a third-party system handles the quoting process. - **[Endorse Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/endorse_policy_without_using_quote.htm)** Policy endorsement, also known as a Mid-Term Adjustment (MTA), is a process where you change an active insurance policy. The endorsement process changes the policy version and the premiums. This user journey shows you how to endorse a policy when Salesforce's quoting capabilities aren't used. - **[Issue Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/issue_policy_without_using_quote.htm)** Issue a new insurance policy when quoting is managed outside Salesforce, by a third-party system. This process results in the creation of a policy record in Salesforce, formally establishing coverage for the customer. - **[Renew Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/renew_policy_without_using_quote.htm)** Policy renewal extends insurance coverage for an additional term, creating a new policy record. This journey details renewing a policy without using Salesforce quoting, relying on the Rating API for pricing the new term. - **[Create Out of Sequence Policy Endorsement](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/out_of_sequence_policy_endorsement_without_using_quote.htm)** Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction. - **[Issue Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/issue_multi_root_policy_without_using_quote.htm)** Creates a new multi-root insurance policy when quoting is managed outside Salesforce by a third-party system. This process uses the Rating API to generate a priced context and create a parent–child policy structure without persisting a quote record. - **[Endorse Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/endorse_multi_root_policy_without_using_quote.htm)** Perform a mid-term adjustment on an active multi-root policy when pricing is handled through the Rating API instead of a Salesforce Quote. This process bypasses the creation of a Quote record while ensuring accurate pricing and versioned updates to the parent and child policies. - **[Renew Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/renew_multi_root_policy_without_using_quote.htm)** Creates a new policy term for a multi-root policy when pricing is handled through the Rating API instead of a quote. This process bypasses the creation of a quote record while generating new parent and child policy records for the renewed term. # Create Claim Action Create a claim. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createClaim Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | createClaimInputRepresentation | Apex-defined | Required. An Apex [ConnectApi.CreateClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim.htm "Input representation for the Create Claim action.") record that contains the details of the claim to be created. | ## Outputs | Output | Type | Description | | --- | --- | --- | | claimId | string | ID of the claim that's created. | ## Example Sample Request { "inputs": \[ { "createClaimInputRepresentation": { "name": "Claim for Auto Accident", "lossDate": "2025-09-15", "claimType": "Auto", "claimReason": "Rear-end collision", "claimReasonType": "Accident", "lossType": "Accident", "insurancePolicyId": "0YTx0000000001qEAA", "accountId": "001xx000003DGQyAAO", "expenseReserveAmount": 750.50, "expenseReserveAdjustmentReason": "Initial expense reserve", "lossReserveAmount": 5000.00, "lossReserveAdjustmentReason": "Initial loss reserve", "additionalFields": { "key": "RepairShop", "value": "NY" }, "attributes": \[ { "apiName": "WeatherConditions", "value": "Clear and Sunny" }, { "apiName": "NumberOfVehicles", "value": "2" } \], "items": \[ { "instanceKey": "item\_vehicle\_damage\_01", "name": "Damaged Rear Bumper and Trunk", "productCode": "AUTO-SEDAN-2023", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": \[ { "apiName": "DamageSeverity", "value": "Moderate" } \], "additionalFields": { "key": "RepairEstimate", "value": 2750 }, "relatedObjects": \[ { "relatedRecordId": "001xx000003DGQzAAP", "relatedRecordObjName": "Account" } \], "participantInstanceKey": "participant\_driver\_01" } \], "participants": \[ { "instanceKey": "participant\_driver\_01", "contactId": "003xx000003DGQyAAO", "accountId": "001xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "isInjured": false, "roles": \[ "Driver", "Claimant" \], "additionalFields": { "StatementTaken": true } } \] } } \] } Sample Response \[ { "actionName": "createClaim", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "claimId": "0Z1S70000004oVfIAI" }, "sortOrder": -1, "version": 1 } \] # Create Claim Coverage Payment Detail Action Create a claim coverage payment detail record. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createClaimCvrPaymentDetail Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | createClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex ConnectApi.CreateClaimCvrPymtDtlInputRep record that contains the details to create the claim coverage payment detail record. | ## Outputs | Output | Type | Description | | --- | --- | --- | | createClaimCvrPymtDtlOutputRep | Apex-defined | An Apex ConnectApi.CreateClaimCvrPymtDtlOutputRep record that contains the details of the claim coverage payment detail record ‌and the generated data for the insurance policy limit tracking and claim coverage payment adjustment records. | ## Example Sample Request { "inputs": \[ { "createClaimCvrPymtDtlInputRep": { "claimId": "0Zkxx000000001dEAA", "claimCoverageId": "0kPxx000000002fEAA", "claimedAmount": 1200, "recipientId": "001xx000003GN2rAAG", "coveragePaymentType": "Loss", "benefitName": "DentalCov", "description": "Dental cleaning and checkup.", "limitUnitCount": 1, "adjustedAmount": 1200, "additionalFields": \[ { "key": "State", "value": "CA" }, { "key": "LOB\_\_c", "value": "Commercial" } \] } } \] } Sample Response { "actionName": "createClaimCvrPaymentDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "createClaimCvrPymtDtlOutputRep": { "adjustedAmount": 200, "adjustedReason": "Deductible", "paymentDetailId": "0lDxx0000004CUmEAM", "insPolicyLimitTrackingIds": \[ "1TExx0000004DUuGAM", "1TExx0000004DUvGAM" \] } }, "sortOrder": -1, "version": 1 } # Create Contacts and Users from Group Census Members Action Create contacts and portal users for group census or group census members. This action supports bulk processing, custom field mapping, and duplicate record detection. It converts insurance group census members to Salesforce Contacs, enables member self-service through portal users, supports B2C enrollment workflows, and maintains relationship data for benefits administration and household grouping. This action is available in API version 65.0 and later. ## Special Access Rules The org must have Digital Insurance Group Benefits enabled. To use this action, you need Census Management user access. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createCtctUsrFrGrpCens Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contactFieldsMapping | Apex-defined | Map of Group Census Member Object fields to Contact fields. | | createPortalUsers | boolean | Indicates whether the portal users must be created ( true ) or not ( false ). | | emailEncodingKey | string | Required if createPortalUsers is set to true . Email encoding key to use to create the user records. For example, ISO-8859-1 or UTF-8. | | groupCensusId | string | Required if groupCensusMembers isn't specified. ID of the group census to create contacts and portal users for the associated group census members. | | groupCensusMembers | sobject | Required if groupCensusId isn't specified. Group census member records to create contacts and portal users for. | | localeSidKey | string | Required if createPortalUsers is set to true . Locale for the user, which affects the format of dates, times, and numbers. | | languageLocaleKey | string | Required if createPortalUsers is set to true . Language to use to create the user records. For example, fr for French or zh\_Cw for Chinese (Traditional). | | matchingKeysList | string | Comma-separated list of contact object fields to detect duplicate contact records. | | profileId | string | Required if createPortalUsers is set to true . ID of the profile to create the user records for. | | timeZoneSidKey | string | Required if createPortalUsers is set to true . Time zone for the user, such as America or Los\_Angeles. | ## Outputs | Output | Type | Description | | --- | --- | --- | | createContactsOutputRep | Apex-defined | An apex ind\_ins\_grpben\_\_ContactsAndUsersCreationOutput record that contains the details of the results. | ## Example Sample Request { "inputs": \[ { "groupCensusMembers": \[ { "Id": "0r6xx00000001tuAAA" }, { "Id": "0r6xx00000001tvAAA" } \], "matchingKeysList": \[ "Email", "LastName" \], "contactFieldsMapping": \[ { "key": "FirstName\_\_c", "value": "FirstName" }, { "key": "Email\_\_c", "value": "Email" } \], "createPortalUsers": true, "profileId": "00exx000000n0ywAAA", "timeZoneSidKey": "America/New\_York", "localeSidKey": "en\_US", "emailEncodingKey": "UTF-8", "languageLocaleKey": "en\_US" } \] } Sample Response { "outputs": \[ { "createContactsOutputRep": { "memberContactDetails": \[ { "groupCensusMemberId": "0r6xx00000001tuAAA", "contactId": "003xx000004WhsgAAC", "userId": "005xx000001X8vwAAC" } \], "errors": \[ { "code": "SF-0004-0058", "message": "Contact already exists for member", "additionalInfo": \[ { "key": "memberId", "value": "0r6xx00000001tvAAA" } \] } \] }, "isSuccess": true } \] } # Create Contract From Quote Asynchronous Action Asynchronously create a group insurance contract from a quote. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createContractFromQuote Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | insuranceContractCreationInputRepresentation | Apex-defined | Required. An Apex [ConnectApi.InsuranceContractCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_creation.htm "Input representation for creating contract.") object that contains the details of the contract to be created. | ## Outputs | Output | Type | Description | | --- | --- | --- | | requestId | string | ID of the asynchronous request that's created when the contract service is initiated. | ## Example Sample Request { "inputs": \[ { "insuranceContractCreationInputRepresentation": { "quoteId": "0Q0SG000000DQA00AO", "contractStartDate": "2025-03-11", "contractEndDate": "2026-03-11", "enrollmentStartDate": "2025-01-01", "enrollmentEndDate": "2025-02-01", "contractTerm": 1, "additionalFields": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "CustomerSignedTitle", "value": "Mr" } \] } }, { "entity": "ContractGroupPlan", "instanceKey": "d5861be1-9920-42d9-8f43-093b0a709d35", "fields": { "data": \[ { "key": "EligibilityCriteria", "value": "testcriteria" } \] } } \] } } \] } Sample Response \[ { "actionName": "createContractFromQuote", "errors": null, "isSuccess": true, "outputValues": { "requestId": "15Uxx0000004XYZABC" } } \] # Create Contract From Quote Synchronous Action Issue a group insurance contract from a quote, creating both the contract and insurance contract records with the full contract group plan hierarchy, including their plan attributes and group class attributes. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/issueContract Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | insuranceIssueContractInputRepresentation | Apex-defined | Required. An Apex ConnectApi.InsuranceIssueContractInputRepresentation record that contains the quote details to issue a contract. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insuranceIssueContractOutputRepresentation | Apex-defined | An Apex ConnectApi.InsuranceIssueContractRepresentation record that contains the result of the contract issue operation, including the contract and insurance contract IDs. | ## Example **POST** This sample request is for the Issue Contract From Quote Synchronous action. { "inputs": \[ { "insuranceIssueContractInputRepresentation": { "quoteId": "0Q0xx0000004C9OCAU", "contractStartDate": "2026-01-11", "contractEndDate": "2028-01-20", "transactionDetailLevel": "COVERAGE\_LEVEL", "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } } \] } This sample response is for the Issue Contract From Quote Synchronous action. \[ { "actionName": "issueContract", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insuranceIssueContractOutputRepresentation": { "contractId": "800xx000000br2bAAA", "errors": \[\], "isSuccess": true, "message": "Contract issued successfully from quote." } }, "sortOrder": -1, "version": 1 } \] # Create Endorsement Draft for Insurance Brokerage Policy Action Start an endorsement draft of an insurance brokerage policy with optional policy detail overrides. This action is available in API version 67.0 and later. ## Special Access Rules This action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/endorseDraftInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_EndorseDraftBrokeragePolicyIAInputRep record that contains the details of the original brokerage policy to endorse. | ## Outputs | Output | Type | Description | | --- | --- | --- | | draftPolicyId | string | ID of the newly created endorsement draft policy. | ## Example **POST** This sample request is for the Create Endorsement Draft for Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001", "endorsementDate": "2026-08-01", "effectiveFromDate": "2026-08-01", "effectiveToDate": "2027-08-01", "policyName": "Updated Policy Name", "policyNumber": "POL-2026-ENDORSED" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for creating an endorsement draft of a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('endorseDraftInsBrokeragePolicy'); // Instantiate the input object ConnectApi.EndorseDraftBrokeragePolicyIAInputRep input = new ConnectApi.EndorseDraftBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the original brokerage policy to endorse input.policyId = '0YjXX0000000001'; // Optional: Set endorsement details input.endorsementDate = '2026-08-01'; input.effectiveFromDate = '2026-08-01'; input.effectiveToDate = '2027-08-01'; input.policyName = 'Updated Policy Name'; input.policyNumber = 'POL-2026-ENDORSED'; // Set the invocation parameter and invoke action.setInvocationParameter('endorseDraftBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Endorse-Draft Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Create Endorsement Draft for Insurance Brokerage Policy action. \[ { "actionName": "endorseDraftInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "draftPolicyId": "0YjXX0000000099" }, "sortOrder": -1, "version": 1 } \] # Create Endorsement or Renewal Quote From Insurance Contract (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. ## Resource {contractId} is a placeholder. /connect/insurance/contracts/{contractId}/actions/generate-quote ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/generate-quote ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the insurance contract. | Required | 68.0 | ## Request Body for POST ### JSON Example { "quoteName": "QuoteFromContract1", "eventEffectiveFromDate": "2027-03-20", "groupCensusId": "0rfxx000000000BAAQ", "transactionType": "GroupInsuranceTransactionType", "insuranceQuoteType": "GroupEndorsement", "configOptions": { "executeConfigurationRules": false, "executeQualificationRules": false }, "additionalFields": { "insuranceQuoteItemList": \[ { "entity": "Quote", "fields": { "data": \[ { "key": "StandardAmount", "value": 80 } \] } }, { "entity": "QuoteLineItem", "productPath": "medBasic", "fields": { "data": \[ { "key": "UnitPrice", "value": 900 } \] } }, { "entity": "QuoteLineItem2", "productPath": "medBasic/pcw1", "fields": { "data": \[ { "key": "PlanAllocationType\_\_std", "value": "STANDARD" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Quote Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_item.htm "Input representation of the details to extend the quote created from a contract.")\[\] | List of additional entity field values to apply when creating the quote. | Optional | 68.0 | | censusRatingType | String | Rating type to use for the census when calculating the quote, such as Summary or Member. | Optional | 68.0 | | configOptions | [Insurance Quote Configuration Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_gb_quote_config_options.htm "Input representation of the details to specify whether configuration and qualification rules run when creating a quote from a contract.") | Configuration options that control whether configuration and qualification rules run during quote creation. | Optional | 68.0 | | eventEffectiveFromDate | String | Date that the quote is effective from. | Required | 68.0 | | eventEffectiveToDate | String | Expiration date of the quote. | Required | 68.0 | | groupCensusId | String | ID of the group census that the quote is created for. | Required | 68.0 | | insuranceQuoteType | String | Type of insurance quote to be created from the contract. | Required | 68.0 | | quoteName | String | Name of the quote. | Optional | 68.0 | | ratingDate | String | Date on which the rating of the quote is calculated. | Optional | 68.0 | | transactionType | String | Type of insurance transaction, such as endorsement or renewal. | Required | 68.0 | ## Response Body for POST [Insurance Create Quote From Contract Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_quote_from_contract_output.htm "Response returned when creating a group benefits quote from an existing contract.") # Create Insurance Quote Action Create an Insurance quote by using a context ID or a set of user inputs that represent quote details. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createInsuranceQuote Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs If you specify quoteInputs (but not contextId) in the request body, you must provide quoteName, priceBookId, and effectiveDate as input parameters. If you specify contextId (but not quoteInputs) in the request body, you must provide these: - either quoteName or SalesTransactionName within additionalFields, and - either priceBookId or PriceBook within additionalFields | Input | Type | Description | | --- | --- | --- | | accountId | String | ID of the account that's associated with the quote being created. | | additionalFields | String | Optional. Map of additional fields that must be updated in the quote context. | | contextId | String | Required if quoteInputs isn't specified. Context ID that's used to issue the quote. | | effectiveDate | Date | Date that the quote becomes effective. | | expirationDate | Date | Optional. Expiration date of the quote. | | opportunityId | String | Optional. ID of the opportunity that's associated with the quote. | | pricebookId | String | Required if either quoteInputs or contextId is specified. ID of the pricebook that's associated with the quote. | | pricingProcedureApiName | String | Optional. API name of the pricing procedure used to price the product. | | quoteInputs | String | Required if contextId isn't specified. Set of user inputs on products that represent the quote details. | | quoteOptions | Apex-defined | An Apex [runtime\_industries\_insurance.CreateInsuranceQuoteOptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm "HTML (New Window)") record that contains details to create the quote. | | quoteName | String | Name of the quote that must be created. | | ratingDate | Date | Optional. Date to find the active pricing procedure. | ## Outputs
Output Details
contextId Type

String

Description

Context ID of the insurance quote that's created.
quoteId Type

String

Description

ID of the insurance quote that's created.
## Example Sample request where quoteInputs is specified in the request body. { "inputs":\[ { "quoteName": "Auto Insurance Quote", "priceBookId" : "01sxx0000005pyfAAA", "accountId": "001xx000003GYwrAAG", "effectiveDate": "2024-10-11", "opportunityId": "006xx000001a2tbAAA", "quoteOptions": { "productSellingModel": "One Time", "saveQuote": true }, "quoteInputs": "\[{"productCode":"autoRoot","instanceKeys":\["AutoRoot"\],"items":\[{"productCode":"autoBundle","instanceKeys":\["AutoRoot","AutoBundle"\],"attributes":{"avMake":"BMW"},"relatedRecords":\[{"relatedRecordId":"001xx000003GYwrAAG","relatedRecordObjName":"Account"}\]},{"productCode":"autoDriver","instanceKeys":\["AutoRoot","AutoBundle","AutoDriver"\],"relatedRecords":\[{"relatedRecordId":"003xx000004WhKhAAK","relatedRecordObjName":"Contact"}\]},{"productCode":"autoRental","instanceKeys":\["AutoRoot","AutoBundle","AutoRental"\]},{"productCode":"autoCollision","instanceKeys":\["AutoRoot","AutoBundle","autoCollision"\],"attributes":{"CollisionBasePremium":250,"autoCollDedClmCov":250}}\]}\]" } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for createInsuranceQuote invocable action public class CreateInsuranceQuoteInvoke { private static final String ACTION\_NAME = 'createInsuranceQuote'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Required inputs (serialize where needed) setInvocationParameter(action, inputs, 'quoteInputs', true); setInvocationParameter(action, inputs, 'quoteName', false); setInvocationParameter(action, inputs, 'priceBookId', false); setInvocationParameter(action, inputs, 'accountId', false); setInvocationParameter(action, inputs, 'effectiveDate', false); // Optional inputs setInvocationParameter(action, inputs, 'contextId', false); setInvocationParameter(action, inputs, 'expirationDate', false); setInvocationParameter(action, inputs, 'additionalFields', true); setInvocationParameter(action, inputs, 'opportunityId', false); // quoteOptions is optional but supported if (inputs != null && inputs.containsKey('quoteOptions')) { Map optionsFromInput = (Map) inputs.get('quoteOptions'); if (optionsFromInput != null) { runtime\_industries\_insurance.CreateInsuranceQuoteOptions quoteOptions = new runtime\_industries\_insurance.CreateInsuranceQuoteOptions(); if (optionsFromInput.containsKey('executePricing')) { quoteOptions.executePricing = (Boolean) optionsFromInput.get('executePricing'); } if (optionsFromInput.containsKey('validateProductCatalog')) { quoteOptions.validateProductCatalog = (Boolean) optionsFromInput.get('validateProductCatalog'); } if (optionsFromInput.containsKey('executeConfigurationRules')) { quoteOptions.executeConfigurationRules = (Boolean) optionsFromInput.get('executeConfigurationRules'); } if (optionsFromInput.containsKey('executeQualificationRules')) { quoteOptions.executeQualificationRules = (Boolean) optionsFromInput.get('executeQualificationRules'); } if (optionsFromInput.containsKey('saveQuote')) { quoteOptions.saveQuote = (Boolean) optionsFromInput.get('saveQuote'); } if (optionsFromInput.containsKey('productSellingModel')) { quoteOptions.productSellingModel = (String) optionsFromInput.get('productSellingModel'); } action.setInvocationParameter('quoteOptions', quoteOptions); } } List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } Sample Response \[ { "actionName": "createInsuranceQuote", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "contextId": "0000000i18tq18g00291753491065771466a599fe8a2440890b4f3d8b4ef40b5", "quoteId": "0Q0SG000000OOUD0A4" }, "sortOrder": -1, "version": 1 } \] # Create Insurance Rating Action Create a runtime context that contains the details to create a quote. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createInsuranceRating Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | additionalFields | String | Additional fields to include in the rating context. | | effectiveDate | Date | Required. Date from which the insurance policy coverage becomes effective. | | executeRating | String | Indicates whether rating must be executed ( true ) or not ( false ). The default value is true . | | ratingDate | Date | Date that's used for rating calculations and rule evaluations. If not specified, the current date is used. | | ratingInputs | Map | Required. JSON string that contains the rating input nodes with product codes and attributes. | | ratingOptions | Apex-defined | An Apex [runtime\_industries\_insurance.CreateInsuranceRatingOptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm) record that contains rating execution options to create insurance rating. | | rootProductCodes | String | Array of root product codes to include in the rating process. | | salesTransactionTypeId | String | ID of the sales transaction type. | | transactionType | String | Type of insurance transaction, such as NewBusiness, Renewal, and Endorsement. | ## Outputs
Output Details
contextId Type

String

Description

Context ID of the insurance quote.
pricingResults Type

Map<String, Object>

Description

Recalculated pricing details of the insurance product.
productRatingOutput Type

Apex-defined

Description

An Apex ConnectApi__ProductRatingOutputRepresentation record that contains the product rating details.
## Example Sample Request { "inputs": \[ { "effectiveDate": "2024-10-18", "ratingInputs": "\[{"instanceKeys":\["AutoRoot","AutoBundle","NewDriver"\],"productCode":"autoDriver","attributes":{"DriverAccidents":4},"targetRecords":\["003xx000004WhKhAAK"\]}\]", "ratingOptions": { "returnRatingResults": true, "returnContextJson": true, "returnProductDetails": true } } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for createInsuranceRating invocable action public class CreateInsuranceRatingInvoke { private static final String ACTION\_NAME = 'createInsuranceRating'; public static Boolean invokeMethod( Map inputs, Map output, Map options ) { Map postPayload = (Map) getValueFromMap('postPayload', inputs, options); System.debug('Rating post Input: ' + postPayload); if (postPayload == null) { output.put('success', false); output.put('errorMessage', 'postPayload is required for rating patch'); output.put('errorType', 'VALIDATION\_ERROR'); return false; } try { System.debug('Calling Invocable Action: createInsuranceRating'); Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); System.debug('RatingInputs: ' + postPayload.get('ratingInputs')); setInvocationParameter(action, postPayload, 'ratingInputs', true); action.setInvocationParameter('transactionType', postPayload.get('transactionType')); setInvocationParameter(action, postPayload, 'additionalFields', true); action.setInvocationParameter('effectiveDate', postPayload.get('effectiveDate')); if (postPayload.containsKey('ratingOptions')) { System.debug('Options:' + postPayload.get('ratingOptions')); Map ratingOptions = (Map) postPayload.get('ratingOptions'); action.setInvocationParameter('ratingOptions', ratingOptions); } List results = action.invoke(); if (results != null && !results.isEmpty()) { Invocable.Action.Result result = results\[0\]; if (result.isSuccess()) { System.debug('Rating post successfully via Invocable Action'); output.put('ratingData', result.getOutputParameters()); List actionErrors = result.getErrors(); if (actionErrors != null && !actionErrors.isEmpty()) { output.put('success', false); output.put('error', result.getErrors()); return false; } output.put('success', true); return true; } else { List actionErrors = result.getErrors(); String errorMessage = 'Rating post Invocable Action failed'; if (actionErrors != null && !actionErrors.isEmpty()) { List errorMessages = new List(); List> errorDetailsList = new List>(); for (Invocable.Action.Error actionError : actionErrors) { errorMessages.add(actionError.getMessage()); errorDetailsList.add(new Map{ 'message' => actionError.getMessage(), 'code' => actionError.getCode() }); } errorMessage = String.join(errorMessages, '; '); output.put('actionErrors', errorDetailsList); } output.put('success', false); output.put('errorMessage', errorMessage); System.debug(LoggingLevel.ERROR, 'Rating post Invocable Action failed: ' + errorMessage); return false; } } else { output.put('success', false); output.put('errorMessage', 'Rating post Invocable Action returned null or empty results'); System.debug(LoggingLevel.WARN, 'Rating post Invocable Action returned null/empty results'); return false; } } catch (Exception e) { String errorMsg = 'Exception: ' + e.getMessage(); output.put('success', false); output.put('errorMessage', errorMsg); output.put('errorType', 'EXCEPTION'); System.debug(LoggingLevel.ERROR, 'Exception while rating post: ' + errorMsg); return false; } } private static Object getValueFromMap(String key, Map inputs, Map options) { if (inputs != null && inputs.get(key) != null && String.isNotBlank(String.valueOf(inputs.get(key)))) { return inputs.get(key); } else if (options != null && options.get(key) != null && String.isNotBlank(String.valueOf(options.get(key)))) { return options.get(key); } return null; } private static void setInvocationParameter( Invocable.Action action, Map payload, String inputAttribute, Boolean serializeJSON ) { if (payload.containsKey(inputAttribute) && payload.get(inputAttribute) != null) { System.debug(inputAttribute + ': ' + JSON.serialize(payload.get(inputAttribute))); if (serializeJSON) { action.setInvocationParameter(inputAttribute, JSON.serialize(payload.get(inputAttribute))); } else { action.setInvocationParameter(inputAttribute, payload.get(inputAttribute)); } } else { System.debug('payload does not contain attribute: ' + inputAttribute); } } } Sample Response \[ { "actionName": "repriceInsuranceProduct", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "contextId": "273e01fdfb6f9f21428869eb784ee756976afb0e9bdc49f2a360be397a10ca12", "productRatingOutput": { "ratingResult": { "childNodes": \[ { "childNodes": \[ { "childNodes": \[ { "childNodes": \[\], "details": { "NetUnitPrice": null, "InstanceKey": "Driver", "ProductCode": "driver", "NetTotalPrice": 0, "Driver\_Accident\_Points": 15, "ProratedQLITaxAmount": 0, "Driver\_MVR\_Points": 8, "Age\_First\_Licensed": 16 } }, { "childNodes": \[\], "details": { "NetUnitPrice": 501.84, "InstanceKey": "Comprehensive", "ProductCode": "comprehensive", "NetTotalPrice": 501.84, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 501.84, "InstanceKey": "Auto1", "ProductCode": "auto", "NetTotalPrice": 501.84, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 1485.84, "InstanceKey": "AutoSilver", "ProductCode": "autoSilver", "NetTotalPrice": 1485.84, "ProratedQLITaxAmount": 0 } } \], "details": {} }, "productDetails": \[ { "productSpecificationType": { "productSpecificationRecordType": {}, "name": "InsuredParty" }, "childProducts": \[\], "additionalFields": { "ProductCode": "driver", "SpecificationType": "InsuredParty", "BasedOnId": "11Bxx000002C1kZEAS", "Name": "Driver" }, "availabilityDate": null, "description": null, "productInformation": null, "childVariationIds": \[\], "isActive": true, "qualificationContext": null, "productClassification": { "id": "11Bxx000002C1kZEAS" }, "productComponentGroups": \[\], "configureDuringSale": "Allowed", "productRelatedComponent": null, "id": "01txx0000006i3iAAA", "prices": \[\], "isComponentRequired": null, "productType": null, "isAssetizable": true, "isSoldOnlyWithOtherProds": false, "attributeCategories": \[ { "code": "Driving History", "records": \[ { "isRequired": false, "code": "AgeFirstLicensed", "additionalFields": {}, "attributeCategoryId": "0v3xx0000000001AAA", "hidden": false, "isConfigurable": false, "dataType": "NUMBER", "label": "Age First Licensed", "isReadOnly": false, "isCloneable": false, "name": "Age First Licensed", "id": "0tjxx000000001FAAQ", "attributeNameOverride": "Age First Licensed", "isPriceImpacting": true, "developerName": "Age\_First\_Licensed", "status": "Active" } \], "name": "Driving History" } \], "nodeType": "simpleProduct", "displayUrl": null, "productSellingModelOptions": \[ { "productSellingModel": { "sellingModelType": "OneTime", "name": "One Time", "id": "0jPxx0000000001EAA", "doesAutoRenewByDefault": false, "status": "Active" }, "productSellingModelId": "0jPxx0000000001EAA", "isDefault": true, "productId": "01txx0000006i3iAAA", "id": "0iOxx000000000zEAA" } \], "productQuantity": null, "productCode": "driver", "name": "Driver" } \], "contextJSON": { "salesTransactions": \[ { "salesTransactionItems": \[ { "salesTransactionItemClauses": \[\], "childNodes": \[ { "salesTransactionItemClauses": \[\], "childNodes": \[\], "salesTransactionItemAttributes": \[ { "fields": { "AttributeKey": "0tjxx000000000PAAQ", "AttributeValue": "50", "ParentReference": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "hasObjectRef": null, "AttributePicklistValue": "0v6xx000000000ZAAQ", "IsPriceImpacting": false, "businessObjectType": "QuoteLineItemAttribute", "AttributeName": "Deductible", "AttributeDefinitionCode": "Deductible", "id": "ref\_fdd78e30\_1258\_4ea3\_9f56\_c74245ae58d6", "SalesTransactionItemAttrParent": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "AttributeDeveloperName": "Deductible" } } \] } \], "salesTransactionItemRelatedObjects": \[\], "salesTransactionItemTaxes": \[\], "fields": { "LevelTwoBasePremium": 120, "IntermediateVariableTwo": null, "Product": "01txx0000006i3UAAQ", "businessObjectType": "QuoteLineItem", "DYN\_\_License\_State": null, "RevenueCloudPackagingFlag": "C", "ValidationResult": null, "DYN\_\_AssetRecordName": null, "PolicyPremium": 1485.84, "PeriodBoundaryStartMonth": null, "SalesTransactionSourceAsset": null, "ProratedQLITaxAmount": 0, "id": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "TaxTreatment": null, "Subtotal": null, "LineItemPath": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc/ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "DiscountAmount": null, "PricebookEntry": null, "NetUnitPrice": 590.4, "ParentSalesTransactionItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "ObligatedAmount": null, "DYN\_\_Age\_First\_Licensed": null, "LevelThreePremium": null, "ProductName": "Bodily Injury & Property Damage", "ProformaBillingPeriodAmount": null, "CommissionAmount": null, "ProductSpec": "Coverage", "DYN\_\_Last\_Name": null, "PricingTermCount": null, "DYN\_\_ContactRecordName": null, "RoundedLineAmount": null, "SalesTransactionAction": null, "TransactionType": null, "PricingTermUnit": null, "BasisTransactionItem": null, "PricingSource": null, "StockKeepingUnit": null, "DYN\_\_Year": null, "PartnerUnitPrice": null, "ItemTotalAdjustmentAmount": null, "ArePartialPeriodsAllowed": false, "DYN\_\_Bodily\_Injury\_Per\_Person\_Limit": 1000, "DYN\_\_Colour": null, "FactorP": null, "FactorO": null, "CustomProductName": null, "SalesTransactionItemParent": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "Quantity": 1, "ContractId": null, "ItemGroupSummarySubtotal": null, "DYN\_\_AccountRecordName": null, "DYN\_\_E\_Mail": null, "DYN\_\_First\_Name": null, "DYN\_\_Bodily\_Injury\_Per\_Accident\_Limit": 1000, "DYN\_\_Driver\_Accident\_Points": null, "SalesItemType": null, "ItemPath": "01txx0000006i3DAAQ/01txx0000006i3UAAQ" }, "salesTransactionItemRelationships": \[ { "fields": { "ParentReference": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "AssociatedItem": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "MainItemRole": null, "ProductRelatedComponent": "0dSxx000000000XEAQ", "businessObjectType": "QuoteLineRelationship", "AssociatedItemPricing": "IncludedInBundlePrice", "ProductRelationshipType": "0yoxx0000000001AAA", "RootItemProductCode": "autoSilver", "IsPriceInclusive": true, "RootItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "RootItemProductSellingModel": null, "AssociatedQuantScaleMethod": null, "MainItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "AssociatedItemRole": null, "SalesTrnItemRelationshipParent": null, "id": "ref\_80623cb4\_3abd\_4ee0\_876a\_c5ca9ecc07fc", "MainItemProduct": "01txx0000006i3DAAQ", "MainItemProductSellingModel": null, "RootItemProduct": "01txx0000006i3DAAQ" } } \] } \], "salesTransactionItemAttributes": \[\], "salesTransactionItemRelatedObjects": \[\], "salesTransactionItemTaxes": \[\], "fields": { "LevelTwoBasePremium": null, "IntermediateVariableTwo": null, "Product": "01txx0000006i3DAAQ", "businessObjectType": "QuoteLineItem", "DYN\_\_License\_State": null, "RevenueCloudPackagingFlag": "C", "ValidationResult": null, "DYN\_\_AssetRecordName": null, "PolicyPremium": 1485.84, "PeriodBoundaryStartMonth": null, "SalesTransactionSourceAsset": null, "ProratedQLITaxAmount": 0, "id": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "DYN\_\_Age": null, "DYN\_\_Property\_Damage\_Per\_Accident\_Limit": null, "DYN\_\_Deductible": null, "STICurrencyIsoCode\_\_std": null, "IntermediateVariableOne": null, "BillingFrequency": null, "DYN\_\_State": null, "DYN\_\_DOB": null, "ProductCode": "autoSilver", "DerivedPricingAttribute": false, "ItemPath": "01txx0000006i3DAAQ" }, "salesTransactionItemRelationships": \[\] } \], "fields": { "Account": null, "BillingCity": null, "businessObjectType": "Quote", "SalesTransactionName": null, "StatusCode": null, "ProratedAmount": 1485.84, "StartDate": "2025-11-04", "CurrencyIsoCode\_\_std": null, "BillingPostalCode": null, "id": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "BillingState": null, "CensusRatingType\_\_std": null, "TransactionType": "AutoTransactionType", "UserProfile": "System Administrator", "QuoteAccount": null, "TotalProratedAmount": 1485.84, "CensusType\_\_std": null, "GroupCensus": null, "SalesTransactionType": null, "Pricebook": null, "Opportunity": null, "ShippingCountry": null, "ShippingCity": null, "StandardAmount": 1485.84, "ProratedTaxAmount": 0, "RatingDate": null, "SalesTransactionSource": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "EffectiveDate": "2025-11-04T00:00:00.000Z", "TotalStandardAmount": 1485.84 }, "appUsageAssignments": \[\] } } }, "sortOrder": -1, "version": 1 } \] # Create Out of Sequence Policy Endorsement Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction. Make sure you have the following details. - Policy ID of the active insurance policy to be endorsed. - Context ID of the endorsement quote created from the policy version that needs modification. - Effective date for the endorsement must fall within a valid policy term. - (Optional) FieldSetIds to copy selected fields (policy, asset, participant, coverage) from the cancelled versions to the new versions. **Example** If a policy has three active versions (V1, V2, and V3) within a single term, and you need to make a change from an effective date which lies in the tenure of V2. You can prepare the context for OOSE using the Quote API. Get the context from policy V2. Use this context to make changes and create an updated quote with the createUpdateQuote APIs. Retrieve the quote context, and then pass this context to OOSE. **Important** When you retrieve the policy context and run a product-rating call, it uses the effective date from the policy context to calculate premiums and taxes. If you later endorse the policy with a different effective date or start date, the endorsed policy still consumes the tax calculations from the earlier product-rating call. To avoid incorrect results, the effective date in the product-rating call must align with the effective date range of the endorsed policy. This ensures that the premiums and taxes are calculated correctly for the endorsement’s term. This diagram outlines the sequence for creating an out-of-sequence policy endorsement using a quote. ![oose\_with\_quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/outofseq_endorse_with_quote.png) 1. **Get Policy Context**—Use the policy ID to get the context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Create Endorsement Quote**—Use the policy context to create a renewal quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Specify the contextId, effectiveDate,and pricebookId during the API call. A new quote record is generated for the policy renewal. 3. **(Optional)Modify Endorsement Quote**—If policyholders want to modify the endorsement quote, make a PATCH request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API with the required changes. An updated, price-adjusted context is returned in the response. 4. **Submit out of sequence endorsement request**—Use the retrieved context to endorse a policy either by: - Making a POST request on the Out-of-Sequence Endorsement Connect API, or - Using the Create Out of Sequence Policy Endorsement invocable action. Specify the policyId, contextId,and effectiveDate and optional details such as custom transaction name, policy name, policy number, and fieldSetIds during the API call. This request returns a jobIdentifier that you can use to track the async process through a custom report. - Identifies and fetches the impacted policy versions. - Locks impacted policy versions to prevent any other operation on the impacted policies when the OOSE request is in progress. - Applies deltas (add, update, delete) across all impacted versions and reprices the context. - Unlocks the impacted policy versions and sends a success or failure notification. - Publishes a platform event that subscribers can use for tracking status. **Expected Results:** - Creates a new policy starting from the effective date of the OOSE endorsement. - Cancels impacted future versions and replaces them with updated versions. - Sets the effective-to date of older versions to endorsementDate – 1 and resets the term premiums and taxes to zero. - Recalculates premiums and taxes on the new versions and prorates them based on the endorsement date. - Creates a transaction record for each policy term and links it to the original policy version of that term for auditing and financial tracking. # Create Out of Sequence Policy Endorsement Perform a backdated change on a policy in the past, current, or future policy term, even when another policy version with an effective date later than the endorsement date already exists. The impacted policy versions are canceled and replaced with new, repriced versions that include the change. The premium impact for each affected policy term is captured in an individual out-of-sequence endorsement transaction. Make sure you have the following details. - Policy ID of the active insurance policy to be endorsed. - Effective date for the endorsement must fall within a valid policy term. - (Optional) FieldSetIds to copy selected fields (policy, asset, participant, coverage) from cancelled versions to the new versions. Example If a policy has three active versions (V1, V2, and V3) within a single term, and you need to make a change from an effective date which lies in the tenure of V2. You can prepare the context for out-of-sequence endorsement using the Rating API. Get the context from policy V2 and pass this context to the patch rating API. Make additions, deletions, or updates to generate an updated context and then pass this context to out-of-sequence endorsement request. This diagram outlines the sequence for creating an out-of-sequence policy endorsement without using a quote. ![oose\_without\_quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/outofseq_endorse_without_quote.png) 1. **Get Policy Context**—Use the policy ID to get the context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Generate Price-Adjusted Context**—Use the context ID and make a PATCH request on the [Insurance Product Ratings](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API. 1. Modify coverages, limits, or deductibles in the payload. The returned context includes updated premiums and tax details. 3. **Submit out of sequence endorsement request**—Use the retrieved context to endorse a policy either by: - Making a POST request on the Out-of-Sequence Endorsement Connect API, or - Using the Create Out of Sequence Policy Endorsement invocable action. Specify the policyId, contextId, effectiveDate and transaction details during the API call. The request returns a jobIdentifier that you can use to track the async process through a custom report. - Identifies and fetches the impacted policy versions. - Locks impacted policy versions to prevent any other operation on the impacted policies when the OOSE request is in progress. - Applies deltas (add, update, delete) across all impacted versions and reprices the context. - Unlocks the impacted policy versions and sends a success or failure notification. - Publishes a platform event that subscribers can use for tracking status. **Expected Results:** - Creates a new policy starting from the effective date of the OOSE endorsement. - Cancels impacted future versions and replaces them with updated versions. - Sets the effective-to date of older versions to endorsementDate – 1 and resets the term premiums and taxes to zero. - Recalculates premiums and taxes on the new versions and prorates them based on the endorsement date. - Creates a transaction record for each policy term and links it to the original policy version of that term for auditing and financial tracking. # Create Out-of-sequence Policy Endorsement Action Create an out-of-sequence endorsement for an insurance policy. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createOutOfSeqPlcyEndorsement Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | outOfSequencePolicyEndorsementInputRep | Apex-defined | Required. An Apex [ConnectApi.OutOfSequenceEndorsePolicyInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_out_of_sequence_endorse_policy_i_a_input_re.htm "Input representation of the details to perform an out-of-sequence endorsement on an insurance policy.") record that contains the details to create the out-of-sequence policy endorsement. | ## Outputs | Output | Type | Description | | --- | --- | --- | | jobIdentifier | string | ID of the job that's created for the out-of-sequence endorsement process. | ## Example **POST** This is a sample request to call this invocable action. { "inputs": \[ { "contextId": "0000000i18tq18g00291750179239892137c4250a82940e49987f6d97559b4de", "effectiveDate": "2025-03-05", "policyId": "" "insurancePolicy": { "policyName": "Life Insurance", "policyNumber": "LI000aax8967245gj" }, "fieldSetIds": { "policyFieldSetId": "0IXxx0000004CYqGAM", "assetFieldSetId": "0IXxx0000004CaSGAU", "participantFieldSetId": "0IXxx0000004CdgGAE", "coverageFieldSetId": "0IXxx0000004Cc4GAE" }, "transactionRecord": { "name": "Custom OOSE transaction" } } \] } This is a sample request to call this invocable action from Apex code. public with sharing class OutOfSequenceEndorsementInvocable { /\*\* \* Execute OOSE with custom parameters \* Usage: OutOfSequenceEndorsement.executeOOSEWithParams('policyId', 'effectiveDate', 'contextId'); \*/ public static void executeOOSEWithParams(String policyId, String effectiveDate, String contextId) { // Validate input parameters if (String.isBlank(policyId) || String.isBlank(effectiveDate) || String.isBlank(contextId)) { System.debug('ERROR: All parameters (policyId, effectiveDate, contextId) are required'); return; } // OOSE IA - Create the standard Invocable Action for out of sequence endorsement Invocable.Action action = Invocable.Action.createStandardAction('createOutOfSeqPlcyEndorsement'); // Instantiate the IA input object for OOSE ConnectApi.outOfSequencePolicyEndorsementInputRep policyInput = new ConnectApi.outOfSequencePolicyEndorsementInputRep(); // Set parameters policyInput.effectiveDate = effectiveDate; policyInput.contextId = contextId; policyInput.policyId = policyId; // Populate Insurance Policy details (using IA classes) ConnectApi.InsPolicyIAInputRep insurancePolicy = new ConnectApi.InsPolicyIAInputRep(); insurancePolicy.policyName = 'Lisa Auto Policy'; insurancePolicy.policyNumber = 'Lisa Auto Policy'; policyInput.insurancePolicy = insurancePolicy; // Set field sets (using IA field set representation) ConnectApi.FieldSetIdsInputRep fieldSetIds = new ConnectApi.FieldSetIdsInputRep(); fieldSetIds.policyFieldSetId = '0IXZM0000008P684AE'; // Replace with your policy field set ID fieldSetIds.assetFieldSetId = '0IXZM0000004DDC4A2'; // Replace with your asset field set ID fieldSetIds.participantFieldSetId = '0IXZM0000004DDH4A2'; // Replace with your participant field set ID fieldSetIds.coverageFieldSetId = '0IXZM0000008P6D4AU'; // Replace with your coverage field set ID policyInput.fieldSetIds = fieldSetIds; // Populate Transaction record (using IA transaction representation) ConnectApi.InsPolicyTrxnIAInputRep transactionRecord = new ConnectApi.InsPolicyTrxnIAInputRep(); transactionRecord.name = 'Custom OOSE Transaction'; policyInput.transactionRecord = transactionRecord; // Set invocation parameters action.setInvocationParameter('outOfSequencePolicyEndorsementInputRep', policyInput); System.debug('Starting OOSE Invocable Action (createOutOfSeqPlcyEndorsement)...'); System.debug('Policy ID: ' + policyId); System.debug('Effective Date: ' + effectiveDate); System.debug('Context ID: ' + contextId); try { // Invoke the action List results = action.invoke(); System.debug('OOSE Invocable Action result = ' + results); // Process results for (Invocable.Action.Result result : results) { if (result.isSuccess()) { System.debug('SUCCESS: Custom OOSE completed successfully!'); Object outputValue = result.getOutputParameters().get('jobIdentifier'); if (outputValue != null) { System.debug('Job Identifier: ' + outputValue); } else { System.debug('OOSE job started - result: ' + result.getOutputParameters()); } } else { System.debug('ERROR: Custom OOSE failed'); System.debug('Error Details: ' + result.getErrors()); } } } catch (Exception e) { System.debug('EXCEPTION in Custom OOSE Invocable Action: ' + e.getMessage()); } } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ OutOfSequenceEndorsementInvocable.executeOOSEWithParams( '0YTZM00000000xG4AQ', // policyId '2025-10-01', // effectiveDate '0000000i18tq18g002917575994042598cecb38226a341dd96349ee513c7c1e5' // contextId ); This is a sample response when you call this action. \[ { "actionName": "createOutOfSeqPlcyEndorsement", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "jobIdentifier": "15Uxx0000004CUWEA2" }, "sortOrder": -1, "version": 1 } \] # Create Person Accounts and Users from Group Census Members Action Create person accounts and portal users for group census or group census members. This action supports bulk processing, custom field mapping, and duplicate detection. This action supports bulk processing, custom field mapping, and duplicate record detection. It converts insurance group census members to Salesforce Person Accounts, enables member self-service through portal users, supports B2C enrollment workflows, and maintains relationship data for benefits administration and household grouping. This action is available in API version 65.0 and later. ## Special Access Rules The org must have Person Accounts and Digital Insurance Group Benefits enabled. To use this action, you need Census Management user access. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createAcctUsrFrGrpCens Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | accountFieldsMapping | Apex-defined | Map of Group Census Member Object fields to Account fields. | | createPortalUsers | boolean | Indicates whether portal users must be created ( true ) or not ( false ). | | emailEncodingKey | string | Required if createPortalUsers is set to true . Email encoding key to use to create the user records. For example, ISO-8859-1 or UTF-8. | | groupCensusId | string | Required if a list of groupCensusMembers isn't specified. ID of the group census to create person accounts and portal users for the associated group census members. | | groupCensusMembers | sobject | Required if groupCensusId isn't specified. Group census member records to create person accounts and portal users. | | languageLocaleKey | string | Required if createPortalUsers is set to true . Language to use to create the user records. For example, fr for French or zh\_Cw for Chinese (Traditional). | | localeSidKey | string | Required if createPortalUsers is set to true . Locale for the user, which affects the format of dates, times, and numbers. | | matchingKeysList | string | Comma-separated list of account object fields to detect duplicate account records. | | profileId | string | Required if createPortalUsers is set to true . ID of the profile to create the user records for. | | recordTypeName | string | API name of the record type to create the person accounts for. | | timeZoneSidKey | string | Required if createPortalUsers is set to true . Time zone for the user, such as America or Los\_Angeles. | ## Outputs | Output | Type | Description | | --- | --- | --- | | createAccountsOutputRep | Apex-defined | An Apex ind\_ins\_grpben\_\_AccountsAndUsersCreationOutput record that contains the details of the results. | ## Example Sample Request { "inputs": \[ { "groupCensusId": "0rfxx000000006dAAA", "recordTypeName": "IndividualMember", "matchingKeysList": \["PersonEmail", "LastName", "PersonBirthdate"\], "accountFieldsMapping": \[ { "key": "FirstName\_\_c", "value": "FirstName" }, { "key": "LastName\_\_c", "value": "LastName" }, { "key": "Email\_\_c", "value": "PersonEmail" }, { "key": "Birthdate\_\_c", "value": "PersonBirthdate" } \], "createPortalUsers": true, "profileId": "00exx000000n0ywAAA", "timeZoneSidKey": "America/New\_York", "localeSidKey": "en\_US", "emailEncodingKey": "UTF-8", "languageLocaleKey": "en\_US" } \] } Sample Response { "outputs": \[ { "AccountsAndUsersCreationOutput": { "groupCensusId": "0rfxx000000006dAAA", "memberAccountDetails": \[ { "groupCensusMemberId": "0r6xx00000001tqAAA", "accountId": "001xx000003Ga7KAAS", "userId": "005xx000001X8vwAAC" } \], "errors": \[ { "code": "SF-0004-0054", "message": "Person Account already exists for member", "additionalInfo": \[ { "key": "memberId", "value": "0r6xx00000001u4AAA" } \] } \] }, "isSuccess": true } \] } # Create Policy Limits Action Create insurance policy limit records for policy coverage and root attributes. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createPolicyLimits Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | createPolicyLimitsInputRep | Apex-defined | Required. An Apex [ConnectApi.CreatePolicyLimitsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_policy_limits_input_re.htm "Input representation for the apex ConnectApi.CreatePolicyLimitsInputRep record that contains the details of the policy limits to be created.") record that contains the details to create the policy limits. | ## Outputs | Output | Type | Description | | --- | --- | --- | | createPolicyLimitsOutputRep | Apex-defined | An Apex ConnectApi.CreatePolicyLimitsOutputRep record that contains the IDs for the insurance policy limit records that are created. | ## Example Sample Request { "inputs": \[ { "createPolicyLimitsInputRep": { "attributeScopes": \[ "Policy", "PolicyCoverage" \], "policyId": "0YTx0000000001qEAA" } } \] } Sample Response \[ { "actionName": "createPolicyLimits", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "createPolicyLimitsOutputRep": { "policyLimitIds": \[ "1plS70000004q2kIAA" \] } }, "sortOrder": -1, "version": 1 } \] # Create Producer Commissions Action Create records for the commissions that producers receive for the insurance policy associated with the specified commission statement line item, and update the commission statement line item record status. This action is available in API version 63.0 and later. ## Special Access Rules The Create Producer Commissions action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need Insurance Commission Management and Insurance Brokerage User permission sets. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createProducerCommissions Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | producerCommissions | sObject | A collection of computed producer commission records to be created. | | commissionStatementLineItemId | String | ID of the commission statement line item record. | | successStatus | String | The status that the associated commission statement line item is set to when the producer commission record is created. | | failureStatus | String | The status that the associated commission statement line item is set to when the producer commission record isn't created. | ## Outputs | Output | Type | Description | | --- | --- | --- | | producerCommissionIds | String | A collection of IDs of the producer commission records that are created. | ## Example **POST** This sample request is for the Create Producer Commissions action. { "inputs": \[ { "commissionStatementLineItemId": "1Atxx0000004DeaCAE", "producerCommissions": \[ { "CommissionAmount": 3000, "InsurancePolicyId": "0YTxx00000002BVGAY", "ProducerId": "0Yxxx00000001IfCAI", "ProducerSplitArngLineItemId" : "1BHxx0000004CXEGA2", "CommissionStatementLineItemId": "1Atxx0000004DeaCAE", "Name": "Sanjeev" }, { "InsurancePolicyId": "0YTxx00000002BVGAY", "ProducerId": "0Yxxx00000001KHCAY", "ProducerSplitArngLineItemId" : "1BHxx0000004CXEGA2", "CommissionStatementLineItemId": "1Atxx0000004DeaCAE", "Name": "Deepak" } \] } \] } This is the sample response for the Create Producer Commissions action. \[ { "actionName": "createProducerCommissions", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "producerCommissionIds": \[ "0kAxx0000000001" \] }, "sortOrder": -1, "version": 1 } \] # Create Quote From Insurance Contract Action Create an endorsement or renewal quote from an existing contract for group insurance. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createQuoteFromInsContract Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | insCreateQuoteFromContractInputRep | Apex-defined | Required. An Apex ConnectApi.InsCreateQuoteFromContractInputRep record that contains the contract ID and details of the quote to be created. | ## Outputs | Output | Type | Description | | --- | --- | --- | | quoteId | string | ID of the quote that's created from the contract. | ## Example **POST** This sample request is for the Create Quote From Insurance Contract action. { "inputs": \[ { "insCreateQuoteFromContractInputRep": { "contractId": "800xx0000004C92AAE", "name": "QuoteFromContract1", "eventEffectiveFromDate": "2025-03-11", "eventEffectiveToDate": "2026-03-11", "transactionType": "GB Endorsement", "insuranceQuoteType": "Endorsement", "groupCensusId": "0rfxx0000004C92AAA", "ratingDate": "2025-03-11", "censusRatingType": "Summary", "configOptions": { "executeConfigurationRules": true, "executeQualificationRules": true }, "additionalFields": { "insuranceQuoteItemList": \[ { "entity": "Quote", "fields": { "data": \[ { "key": "StandardAmount", "value": 80 } \] } } \] } } } \] } This sample response is for the Create Quote From Insurance Contract action. \[ { "actionName": "createQuoteFromInsContract", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "quoteId": "0Q0xx0000004C92AAE" }, "sortOrder": -1, "version": 1 } \] # createBillingSchedulesFromTransaction(InsuranceTransactionBillingInput) Create billing schedules from an insurance transaction. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceTransactionBillingOutputRepresentation createBillingSchedulesFromTransaction(ConnectApi.InsuranceTransactionBillingInputRepresentation InsuranceTransactionBillingInput) ## Parameters **InsuranceTransactionBillingInput** - Type: [ConnectApi.InsuranceTransactionBillingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_transaction_billing.htm "Input representation of the details to create billing schedules from an insurance transaction.") - Details to create billing schedules from an insurance transaction. ## Return Value Type: [ConnectApi.InsuranceTransactionBillingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_transaction_billing_output.htm "Output representation of the result of creating billing schedules from an insurance transaction.") ## Example This is a sample to call the Create Billing Schedules connect API from Apex. **Class Definition** public with sharing class CreateInsuranceBillingScheduleCallable implements System.Callable{ public Object call(String actionType, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Retrieve the insurance policy transaction input data from the input map ConnectApi.InsuranceTransactionBillingInputRepresentation insuranceTransactionInput = (ConnectApi.InsuranceTransactionBillingInputRepresentation)inputMap.get('insuranceTransactionInput'); String insPolicyTransactionId = (String) inputMap.get('insPolicyTransactionId'); System.debug('Start of connect API call to Insurance Transaction Billing'); // Initialize the insurance transaction billing output representation ConnectApi.InsuranceTransactionBillingOutputRepresentation transactionBillingOutcome; // Call the Connect API to send the insurance transaction to billing try { transactionBillingOutcome = ConnectApi.InsuranceBillingFamily.createBillingSchedulesFromTransaction(insuranceTransactionInput); System.debug('Policy transaction send to billing successfully: ' + transactionBillingOutcome); // Put the transaction billing outcome in the output map outputMap.put('transactionBillingOutcome', transactionBillingOutcome); } catch (Exception e) { System.debug('Error while sending transaction to billing: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the transaction billing outcome return transactionBillingOutcome; } } **Usage Example** global class ConnectDriver { global static void callInsuranceBillingConnectAPI(String insPolicyTransactionId){ Map input = new Map(); CreateInsuranceBillingScheduleCallable callable = new CreateInsuranceBillingScheduleCallable(); // Create and populate the InsuranceTransactionBillingInputRepresentation object ConnectApi.InsuranceTransactionBillingInputRepresentation insuranceTransactionInput = new ConnectApi.InsuranceTransactionBillingInputRepresentation(); // Populate transactionId for InsuranceTransactionBillingInputRepresentation insuranceTransactionInput.insPolicyTransactionId = insPolicyTransactionId; // Add the insuranceTransactionInput to the input map input.put('insuranceTransactionInput', insuranceTransactionInput); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'insuranceBillingService' action Object result = callable.call('InsuranceBilling', args); // Retrieve the policy data from the result ConnectApi.InsuranceTransactionBillingOutputRepresentation transactionBillingOutcome = (ConnectApi.InsuranceTransactionBillingOutputRepresentation) result; // Output the policy data to the debug log System.debug('Insurance Transaction Billing API Response: ' + JSON.serializePretty(transactionBillingOutcome)); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } # CreateClaim(CreateClaimInput) Create a claim record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.CreateClaimOutputRepresentation CreateClaim(ConnectApi.ClaimInputRepresentation CreateClaimInput) ## Parameters **CreateClaimInput** - Type: [ConnectApi.ClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim.htm "Input representation for creating or updating a claim.") - Details to create a claim. ## Return Value Type: [ConnectApi.CreateClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_claim_output.htm "Output representation for a create or update claim operation.") ## Example Use this Apex example to create a new insurance claim by using the Create Claim API. This example shows how to create a ClaimInputRepresentation with claim details, participants, and items, and then invoke the Connect API method ConnectApi.ClaimFamily.CreateClaim() to submit the claim. **Class Definition** This Apex sample shows how to use the Create Claim API from the Connect API namespace to create an insurance claim record. The example includes building nested input structures for claim details, participants, claim items, and related objects. public with sharing class CreateClaimCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'createClaim') { // Retrieve the claim input data from the input map ConnectApi.ClaimInputRepresentation claimInput = (ConnectApi.ClaimInputRepresentation) inputMap.get('claimInput'); System.debug('Start of connect API call to create claim'); // Initialize the claim output representation ConnectApi.CreateClaimOutputRepresentation claimData; // Call the Connect API to create the claim try { claimData = ConnectApi.ClaimFamily.createClaim(claimInput); System.debug('Claim created successfully: ' + claimData); // Put the claim data in the output map outputMap.put('claimData', claimData); } catch (Exception e) { System.debug('Error while creating claim: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the claim data return claimData; } // If the action is not recognized, return null return null; } } **Usage Example** Use the CreateClaimCallable class to invoke the createClaim action and submit a new claim. CreateClaimCallable callable = new CreateClaimCallable(); // Prepare the input arguments Map input = new Map(); // Create and populate the ClaimInputRepresentation object ConnectApi.ClaimInputRepresentation claimInput = new ConnectApi.ClaimInputRepresentation(); // Set basic claim fields claimInput.name = 'Claim-Demo-Test-apex-1'; claimInput.claimType = 'Auto'; claimInput.lossDate = DateTime.now(); claimInput.productCode = 'AutoClaimRoot'; claimInput.claimReasonType = 'Accident'; claimInput.claimReason= 'Damage'; claimInput.lossType = 'Partial Loss'; claimInput.insurancePolicyId = '0YTxx000000000iGAA'; claimInput.accountId = '001xx000003GYiEAAW'; claimInput.expenseReserveAmount = 750.50; claimInput.expenseReserveAdjustmentReason = 'Initial expense reserve'; claimInput.lossReserveAmount = 5000.00; claimInput.lossReserveAdjustmentReason = 'Initial loss reserve'; // Set additional fields Map additionalFields = new Map(); additionalFields.put('Severity', 'High'); claimInput.additionalFields = additionalFields; // Set claim items List itemList = new List(); // Create first item ConnectApi.ClaimItemInputRepresentation item1 = new ConnectApi.ClaimItemInputRepresentation(); item1.name = 'item1'; item1.category = 'Involved Injury'; item1.productCode = 'InvolvedInjury'; item1.instanceKey = 'item1'; item1.insuredItemId = '0YWxx00000000NbGAI'; item1.insurancePolicyCoverageId = '0cYxx0000000125EAA'; item1.participantInstanceKey = 'par1'; // Set item attributes List item1AttrList = new List(); ConnectApi.ClaimAttributeInputRepresentation genderAttr = new ConnectApi.ClaimAttributeInputRepresentation(); genderAttr.apiName = 'Gender'; genderAttr.value = 'Female'; item1AttrList.add(genderAttr); item1.attributes = item1AttrList; // Set item additional fields Map item1AdditionalFields = new Map(); item1AdditionalFields.put('Description', 'test'); item1.additionalFields = item1AdditionalFields; // Set item related objects List relatedObjList = new List(); ConnectApi.ClaimRelatedObjectInputRepresentation accountRel = new ConnectApi.ClaimRelatedObjectInputRepresentation(); accountRel.recordId = '001xx000003GYiBAAW'; accountRel.recordObjName = 'Account'; relatedObjList.add(accountRel); item1.relatedObjects = relatedObjList; itemList.add(item1); claimInput.items = itemList; // Set claim participants List participantList = new List(); // Create first participant ConnectApi.ClaimParticipantInputRepresentation participant1 = new ConnectApi.ClaimParticipantInputRepresentation(); participant1.instanceKey = 'par1'; participant1.accountId = '001xx000003GYiEAAW'; participant1.contactId = '003xx000004WhFwAAK'; participant1.insurancePolicyParticipantId = '0aoxx00000000SQAAY'; participant1.isInjured = 'true'; participant1.roles = new List{'Claimant', 'Involved Driver'}; participantList.add(participant1); // Create second participant ConnectApi.ClaimParticipantInputRepresentation participant2 = new ConnectApi.ClaimParticipantInputRepresentation(); participant2.instanceKey = 'par2'; participant2.contactId = '003xx000004WhFwAAK'; participant2.isInjured = 'true'; participant2.roles = new List{'Claimant', 'Involved Driver'}; participantList.add(participant2); claimInput.participants = participantList; // Add the claimInput to the input map input.put('claimInput', claimInput); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'createClaim' action Object result = callable.call('createClaim', args); // Retrieve the claim data from the result ConnectApi.CreateClaimOutputRepresentation claimData = (ConnectApi.CreateClaimOutputRepresentation) result; // Output the claim data to the debug log System.debug('Claim Data: ' + JSON.serializePretty(claimData)); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # CreateClaimCoverage(claimId, CreateClaimCoverageInput) Create a claim coverage record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.ClaimCoverageRepresentation CreateClaimCoverage(String claimId, ConnectApi.CreateClaimCoverageInputRepresentation CreateClaimCoverageInput) ## Parameters **claimId** - Type: String - ID of the claim to add coverage to. **CreateClaimCoverageInput** - Type: [ConnectApi.CreateClaimCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim_coverage.htm "Input representation for creating a claim coverage.") - Object that contains the details to create the claim coverage. ## Return Value Type: [ConnectApi.ClaimCoverageRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_coverage.htm "Output representation for a claim coverage operation.") ## Example The Apex example shows how to use the ConnectApi.InsuranceClaimFamily.CreateClaimCoverage() method to create a claim coverage for an existing claim. **Class Definition** public with sharing class CreateClaimCoverageCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'createClaimCoverage') { // Retrieve the coverage input data from the input map ConnectApi.CreateClaimCoverageInputRepresentation coverageInput = (ConnectApi.CreateClaimCoverageInputRepresentation) inputMap.get('coverageInput'); System.debug('Start of Connect API call to create claim coverage'); // Initialize the coverage output representation ConnectApi.ClaimCoverageRepresentation coverageData; try { // Call the Connect API to create the claim coverage // Replace the claim ID with the appropriate value for your org coverageData = ConnectApi.ClaimFamily.createClaimCoverage( '0Zkxx00000000JNCAY', // Claim ID coverageInput ); System.debug('Claim coverage created successfully: ' + coverageData); // Put the coverage data in the output map outputMap.put('coverageData', coverageData); } catch (Exception e) { System.debug('Error while creating claim coverage: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the coverage data return coverageData; } // If the action is not recognized, return null return null; } } **Usage Example** This example shows how to call the CreateClaimCoverageCallable class and include the required input data. CreateClaimCoverageCallable callable = new CreateClaimCoverageCallable(); // Prepare the input arguments Map input = new Map(); // Create and populate the CreateClaimCoverageInputRepresentation object ConnectApi.CreateClaimCoverageInputRepresentation coverageInput = new ConnectApi.CreateClaimCoverageInputRepresentation(); // Set required fields coverageInput.claimParticipantId = '0aSxx00000000CvEAI'; coverageInput.claimItemId = '0dqxx00000000McAAI'; coverageInput.insurancePolicyAssetId = '0YWxx00000000P5GAI'; coverageInput.insurancePolicyCoverageId = '0cYxx000000012GEAQ'; coverageInput.name = 'Apex Cov Test'; // Set optional fields coverageInput.lossReserveAmount = 25000.00; coverageInput.expenseReserveAmount = 2500.00; coverageInput.reserveProcessingMode = 'CoverageReserve'; coverageInput.currencyIsoCode = 'USD'; // Set additional fields Map additionalFields = new Map(); additionalFields.put('Description', 'Coverage for vehicle damage claim'); coverageInput.additionalFields = additionalFields; // Add the coverageInput to the input map input.put('coverageInput', coverageInput); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'createClaimCoverage' action Object result = callable.call('createClaimCoverage', args); // Retrieve the coverage data from the result ConnectApi.ClaimCoverageRepresentation coverageData = (ConnectApi.ClaimCoverageRepresentation) result; // Log the created coverage data System.debug('Coverage Data: ' + JSON.serializePretty(coverageData)); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # CreateClaimCoveragePaymentDetail(CreateClaimCoveragePaymentDetailInput, claimId, coverageId) Create a claim coverage payment detail record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.CreateClaimCoveragePaymentDetailRep CreateClaimCoveragePaymentDetail(ConnectApi.CreateClaimCovPaymentDetailInputRep CreateClaimCoveragePaymentDetailInput, String claimId, String coverageId) ## Parameters **CreateClaimCoveragePaymentDetailInput** - Type: [ConnectApi.CreateClaimCovPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_claim_coverage_payment_detail.htm "Input representation for creating a claim coverage payment detail record.") - Representation details to create the claim coverage payment detail record. **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage. ## Return Value Type: [ConnectApi.CreateClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_claim_coverage_payment_detail.htm "Output representation for the details of the create claim coverage payment detail record.") ## Example Here's an example of how to invoke the Create CCPD API by using Apex. public with sharing class CreateCCPDIPTest3 implements System.Callable { public Object call(String action, Map args) { System.debug('>>> Action: ' + action); System.debug('>>> Args: ' + JSON.serializePretty(args)); Map bodyMap = new Map(); // Extract 'input' and 'output' Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (inputMap != null) { if (inputMap.containsKey('claimId') && inputMap.get('claimId') != null) { bodyMap.put('claimId', String.valueOf(inputMap.get('claimId'))); } if (inputMap.containsKey('claimCoverageId') && inputMap.get('claimCoverageId') != null) { bodyMap.put('claimCoverageId', String.valueOf(inputMap.get('claimCoverageId'))); } if (inputMap.containsKey('claimedAmount') && inputMap.get('claimedAmount') != null) { bodyMap.put('claimedAmount', String.valueOf(inputMap.get('claimedAmount'))); } if (inputMap.containsKey('coveragePaymentType') && inputMap.get('coveragePaymentType') != null) { bodyMap.put('coveragePaymentType', String.valueOf(inputMap.get('coveragePaymentType'))); } if (inputMap.containsKey('adjustedAmount') && inputMap.get('adjustedAmount') != null) { bodyMap.put('adjustedAmount', String.valueOf(inputMap.get('adjustedAmount'))); } } else { System.debug('⚠️ No input map found in args'); } String jsonBody = JSON.serialize(bodyMap); System.debug('>>> Final JSON Body: ' + jsonBody); String str = postDataToExternalApi(bodyMap, jsonBody); return outputMap.put('response', str); } public static String postDataToExternalApi(Map bodyMap, String jsonBody) { HttpRequest request = new HttpRequest(); Http http = new Http(); String claimId = (String) bodyMap.get('claimId'); String claimCoverageId = (String) bodyMap.get('claimCoverageId'); bodyMap.remove('claimId'); bodyMap.remove('claimCoverageId'); jsonBody = JSON.serialize(bodyMap); System.debug('>>> Final JSON Body: ' + jsonBody); if (String.isBlank(claimId) || String.isBlank(claimCoverageId)) { String errorMsg = 'Missing required fields - claimId: ' + claimId + ', claimCoverageId: ' + claimCoverageId; System.debug('⚠️ ' + errorMsg); return 'Error: ' + errorMsg; } // ✅ Build endpoint dynamically String endpoint = 'callout:invokeUW/services/data/v65.0/connect/insurance/claims/' + claimId + '/coverages/' + claimCoverageId + '/payment-details'; System.debug('>>> Dynamic Endpoint: ' + endpoint); request.setEndpoint(endpoint); request.setMethod('POST'); request.setHeader('Content-Type', 'application/json'); request.setTimeout(120000); // 2 mins request.setBody(jsonBody); try { HttpResponse response = http.send(request); System.debug('>>> Status Code: ' + response.getStatusCode()); System.debug('>>> Response Body: ' + response.getBody()); return response.getBody(); } catch (Exception e) { System.debug('Exception: ' + e.getMessage()); return 'Exception: ' + e.getMessage(); } } // Sample test method public static void testCreateCCPD() { Map args = new Map(); Map input = new Map(); Map output = new Map(); input.put('claimId', '0Zkxx000000009hCAA'); input.put('claimCoverageId', '0kPxx000000006TEAQ'); input.put('claimedAmount', '1200.0'); input.put('coveragePaymentType', 'Loss'); input.put('adjustedAmount', '1200.0'); args.put('input', input); args.put('output', output); CreateCCPDIPTest1 test = new CreateCCPDIPTest1(); test.call('createCCPD', args); } } # CreateInsuranceQuoteOptions Class Contains options for creating an insurance quote. Use this class to control pricing execution, product catalog validation, configuration and qualification rules, quote persistence, and the product selling model when creating group or individual insurance quotes. ## Namespace [runtime\_industries\_insurance](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm "The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.") ## Usage Use the CreateInsuranceQuoteOptions class with the [Insurance Quote (POST)](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) API and the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm) invocable action to create an insurance quote so that you can specify which operations to run and whether to save the quote or not. ## Example When calling the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm) invocable action from Apex, create a CreateInsuranceQuoteOptions instance, set the desired properties, and then use it as quoteOptions. runtime\_industries\_insurance.CreateInsuranceQuoteOptions createQuoteOptions = new runtime\_industries\_insurance.CreateInsuranceQuoteOptions(); Map optionsFromInput = (Map)quotePayload.get('quoteOptions'); if (optionsFromInput.containsKey('executePricing')) { createQuoteOptions.executePricing = (Boolean)optionsFromInput.get('executePricing'); } if (optionsFromInput.containsKey('validateProductCatalog')) { createQuoteOptions.validateProductCatalog = (Boolean)optionsFromInput.get('validateProductCatalog'); } if (optionsFromInput.containsKey('executeConfigurationRules')) { createQuoteOptions.executeConfigurationRules = (Boolean)optionsFromInput.get('executeConfigurationRules'); } if (optionsFromInput.containsKey('executeQualificationRules')) { createQuoteOptions.executeQualificationRules = (Boolean)optionsFromInput.get('executeQualificationRules'); } if (optionsFromInput.containsKey('saveQuote')) { createQuoteOptions.saveQuote = (Boolean)optionsFromInput.get('saveQuote'); } if (optionsFromInput.containsKey('productSellingModel')) { createQuoteOptions.productSellingModel = (String)optionsFromInput.get('productSellingModel'); } action.setInvocationParameter('quoteOptions', createQuoteOptions); - **[CreateInsuranceQuoteOptions Constructors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_constructors)** Learn more about the constructors that are available with the CreateInsuranceQuoteOptions class. - **[CreateInsuranceQuoteOptions Properties](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_properties)** Set the CreateInsuranceQuoteOptions class properties to create an insurance quote. ## CreateInsuranceQuoteOptions Constructors Learn more about the constructors that are available with the CreateInsuranceQuoteOptions class. The CreateInsuranceQuoteOptions class includes these constructors. - **[CreateInsuranceQuoteOptions(executePricing, validateProductCatalog, executeConfigurationRules, executeQualificationRules, saveQuote, productSellingModel)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_ctor)** Creates an options instance for quote creation with explicit control over pricing, validation, rules execution, quote saving, and product selling model. - **[CreateInsuranceQuoteOptions()](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_ctor_2)** Creates an options instance with the default settings for creating an insurance quote. ### CreateInsuranceQuoteOptions(executePricing, validateProductCatalog, executeConfigurationRules, executeQualificationRules, saveQuote, productSellingModel) Creates an options instance for quote creation with explicit control over pricing, validation, rules execution, quote saving, and product selling model. #### Signature public CreateInsuranceQuoteOptions(Boolean executePricing, Boolean validateProductCatalog, Boolean executeConfigurationRules, Boolean executeQualificationRules, Boolean saveQuote, String productSellingModel) #### Parameters **executePricing** - Type: Boolean - Indicates whether to execute pricing when creating the quote (true) or not (false). The default value is false. **validateProductCatalog** - Type: Boolean - Indicates whether to validate against product catalog (true) or not (false). The default value is false. **executeConfigurationRules** - Type: Boolean - Indicates whether to run product configuration rules (true) or not (false). The default value is false. **executeQualificationRules** - Type: Boolean - Indicates whether to run qualification rules (true) or not (false). The default value is false. **saveQuote** - Type: Boolean - Indicates whether to save the details after the quote is created (true) or not (false). The default value is false. **productSellingModel** - Type: String - ID of the product selling model for the quote. ### CreateInsuranceQuoteOptions() Creates an options instance with the default settings for creating an insurance quote. #### Signature public CreateInsuranceQuoteOptions() ## CreateInsuranceQuoteOptions Properties Set the CreateInsuranceQuoteOptions class properties to create an insurance quote. The CreateInsuranceQuoteOptions class includes these properties. - **[executeConfigurationRules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_executeConfigurationRules)** Indicates whether product configuration rules are executed when creating the insurance quote (true) or not (false). - **[executePricing](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_executePricing)** Indicates whether pricing is executed when creating the insurance quote (true) or not (false). - **[executeQualificationRules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_executeQualificationRules)** Indicates whether qualification rules are executed when creating the insurance quote (true) or not (false). - **[productSellingModel](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_productSellingModel)** Identifies the product selling model that's used for the insurance quote, for example, group or individual. - **[saveQuote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_saveQuote)** Indicates whether the created quote is saved in the database (true) or not (false). - **[validateProductCatalog](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_CreateInsuranceQuoteOptions_validateProductCatalog)** Indicates whether the product catalog is validated when creating the insurance quote (true) or not (false). ### executeConfigurationRules Indicates whether product configuration rules are executed when creating the insurance quote (true) or not (false). #### Signature public Boolean executeConfigurationRules {get; set;} #### Property Value Type: Boolean ### executePricing Indicates whether pricing is executed when creating the insurance quote (true) or not (false). #### Signature public Boolean executePricing {get; set;} #### Property Value Type: Boolean ### executeQualificationRules Indicates whether qualification rules are executed when creating the insurance quote (true) or not (false). #### Signature public Boolean executeQualificationRules {get; set;} #### Property Value Type: Boolean ### productSellingModel Identifies the product selling model that's used for the insurance quote, for example, group or individual. #### Signature public String productSellingModel {get; set;} #### Property Value Type: String ### saveQuote Indicates whether the created quote is saved in the database (true) or not (false). #### Signature public Boolean saveQuote {get; set;} #### Property Value Type: Boolean ### validateProductCatalog Indicates whether the product catalog is validated when creating the insurance quote (true) or not (false). #### Signature public Boolean validateProductCatalog {get; set;} #### Property Value Type: Boolean # CreateInsuranceRatingOptions Class Contains options for creating an insurance rating. Use this class to control pricing execution, configuration rules, and the response data, such as context JSON, product details, rating results, when running a rating operation. ## Namespace [runtime\_industries\_insurance](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm "The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.") ## Usage Use the CreateInsuranceRatingOptions class when using the [Create Insurance Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_insurance_rating.htm) invocable action to create an insurance rating so that you can specify which operations to run and what response data to include. ## Example Create a CreateInsuranceRatingOptions instance and set properties, then use it (or a serialized map) as ratingOptions when calling the [Create Insurance Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_insurance_rating.htm) invocable action from Apex. // Build rating options for createInsuranceRating runtime\_industries\_insurance.CreateInsuranceRatingOptions ratingOptions = new runtime\_industries\_insurance.CreateInsuranceRatingOptions( true, // executePricing true, // executeConfigurationRules false, // returnContextJSON true, // returnProductDetails true // returnRatingResults ); // Pass ratingOptions when invoking the createInsuranceRating action action.setInvocationParameter('ratingOptions', ratingOptions); - **[CreateInsuranceRatingOptions Constructors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_constructors)** Learn more about the constructors that are available with the CreateInsuranceRatingOptions class. - **[CreateInsuranceRatingOptions Properties](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_properties)** Set the properties in the CreateInsuranceRatingOptions class to create insurance ratings. ## CreateInsuranceRatingOptions Constructors Learn more about the constructors that are available with the CreateInsuranceRatingOptions class. The CreateInsuranceRatingOptions class includes these constructors. - **[CreateInsuranceRatingOptions(executePricing, executeConfigurationRules, returnContextJSON, returnProductDetails, returnRatingResults)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_ctor)** Creates an options instance for rating with explicit control over pricing, configuration rules, and which data is returned in the response. - **[CreateInsuranceRatingOptions()](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_ctor_2)** Creates an options instance with the default settings for creating an insurance rating. ### CreateInsuranceRatingOptions(executePricing, executeConfigurationRules, returnContextJSON, returnProductDetails, returnRatingResults) Creates an options instance for rating with explicit control over pricing, configuration rules, and which data is returned in the response. #### Signature public CreateInsuranceRatingOptions(Boolean executePricing, Boolean executeConfigurationRules, Boolean returnContextJSON, Boolean returnProductDetails, Boolean returnRatingResults) #### Parameters **executePricing** - Type: Boolean - Indicates whether to execute pricing for the rating (true) or not (false). The default value is true. **executeConfigurationRules** - Type: Boolean - Indicates whether to run product configuration rules (true) or not (false). The default value is false. **returnContextJSON** - Type: Boolean - Indicates whether to include context as JSON in the response (true) or not (false). The default value is false. **returnProductDetails** - Type: Boolean - Indicates whether to include product details in the response (true) or not (false). The default value is false. **returnRatingResults** - Type: Boolean - Indicates whether to include rating results in the response (true) or not (false). The default value is false. ### CreateInsuranceRatingOptions() Creates an options instance with the default settings for creating an insurance rating. #### Signature public CreateInsuranceRatingOptions() ## CreateInsuranceRatingOptions Properties Set the properties in the CreateInsuranceRatingOptions class to create insurance ratings. The following are properties for CreateInsuranceRatingOptions. - **[executeConfigurationRules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_executeConfigurationRules)** Indicates whether to run product configuration rules (true) or not (false). - **[executePricing](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_executePricing)** Indicates whether to execute pricing for the rating (true) or not (false). - **[returnContextJSON](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_returnContextJSON)** Indicates whether to include context as JSON in the response (true) or not (false). - **[returnProductDetails](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_returnProductDetails)** Indicates whether to include product details in the response (true) or not (false). - **[returnRatingResults](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_runtime_industries_insurance_CreateInsuranceRatingOptions_returnRatingResults)** Indicates whether to include rating results in the response (true) or not (false). ### executeConfigurationRules Indicates whether to run product configuration rules (true) or not (false). #### Signature public Boolean executeConfigurationRules {get; set;} #### Property Value Type: Boolean ### executePricing Indicates whether to execute pricing for the rating (true) or not (false). #### Signature public Boolean executePricing {get; set;} #### Property Value Type: Boolean ### returnContextJSON Indicates whether to include context as JSON in the response (true) or not (false). #### Signature public Boolean returnContextJSON {get; set;} #### Property Value Type: Boolean ### returnProductDetails Indicates whether to include product details in the response (true) or not (false). #### Signature public Boolean returnProductDetails {get; set;} #### Property Value Type: Boolean ### returnRatingResults Indicates whether to include rating results in the response (true) or not (false). #### Signature public Boolean returnRatingResults {get; set;} #### Property Value Type: Boolean # CreatePolicyLimits(policyId, CreatePolicyLimitsInput) insurance policy limit records for the specified policy based on the defined attributes and coverages of the insurance policy. ## Version 64.0 ## Requires No ## Signature public static ConnectApi.CreatePolicyLimitsRepresentation CreatePolicyLimits(String policyId, ConnectApi.CreatePolicyLimitsInputRepresentation CreatePolicyLimitsInput) ## Parameters **policyId** - Type: String - of the policy to generate limits for. **CreatePolicyLimitsInput** - Type: [ConnectApi.CreatePolicyLimitsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_create_policy_limits.htm "Input representation for creating insurance policy limit records.") - that specifies the attribute scopes for which the policy limit records be created. ## Return Value Type: [ConnectApi.CreatePolicyLimitsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_policy_limits.htm "Output representation of the created insurance policy limit records.") ## Example This Apex example shows how to call the CreatePolicyLimits method to automatically generate limit tracking records that are associated with a given policy ID. **Class Definition** public with sharing class CreatePolicyLimitsCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'createPolicyLimits') { // Retrieve the policy ID from the input map String policyId = (String) inputMap.get('policyId'); System.debug('Start of connect API call to create policy limits'); System.debug('Policy ID: ' + policyId); // Initialize the output representation ConnectApi.CreatePolicyLimitsRepresentation policyLimitsData; // Call the Connect API to create policy limits try { // Call the Connect API resource directly using the correct method signature policyLimitsData = ConnectApi.InsuranceClaimFamily.createPolicyLimits(policyId); System.debug('Policy limits created successfully: ' + policyLimitsData); // Put the policy limits data in the output map outputMap.put('policyLimitsData', policyLimitsData); } catch (Exception e) { System.debug('Error while creating policy limits: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the policy limits data return policyLimitsData; } // If the action is not recognized, return null return null; } } **Usage Example** CreatePolicyLimitsCallable callable = new CreatePolicyLimitsCallable(); // Prepare the input arguments Map input = new Map(); // Set the policy ID (required) input.put('policyId', '0YTxx000000001LGAQ'); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'createPolicyLimits' action Object result = callable.call('createPolicyLimits', args); // Check the result if (result != null) { System.debug('Policy limits created successfully: ' + result); // Access the created policy limits data ConnectApi.CreatePolicyLimitsRepresentation policyLimitsData = (ConnectApi.CreatePolicyLimitsRepresentation) result; // Process the result as needed System.debug('Policy Limits Data: ' + policyLimitsData); // Access the generated policy limit IDs if (policyLimitsData.policyLimitIds != null) { System.debug('Generated Policy Limit IDs: ' + policyLimitsData.policyLimitIds); System.debug('Number of limits generated: ' + policyLimitsData.policyLimitIds.size()); } } else { System.debug('Error occurred: ' + output.get('error')); } # Deep Clone Group Census (POST) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/actions/deep-clone ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/actions/deep-clone ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the source group census to clone. | Required | 68.0 | ## Request Body for POST ### JSON Example { "contextDefId": "Custom\_GroupCensus\_DeepClone", "groupCensusFilters": { "memberPlanFilter": { "quoteId": "0Q0xx0000004CtoCAE" } }, "groupCensusReferenceMappings": { "memberPlanReferenceMapping": { "contractId": "800xx0000004C92AAE" } }, "targetGroupCensusOverrides": { "Name": "Acme Enrollment Census", "Description": "Enrollment census cloned from the quoting census" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextDefId | String | API name of the custom context definition that overrides the standard group census deep-clone context definition. Use this property when you need unique fields or specialized mappings that the standard context definition doesn't include. | Optional | 68.0 | | groupCensusFilters | [Group Census Filters Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_filters_input.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that limit which records in the source census hierarchy are cloned. For example, clone only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [Group Census Reference Mappings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_reference_mappings_input.htm "Input representation of the per-entity reference values saved to group census member plan records.") | Reference mappings to apply on the cloned records. Use these mappings to associate source references with target references, such as mapping quote line items to contract group plans. | Optional | 68.0 | | targetGroupCensusOverrides | Object | Map of field API names and values to apply to the cloned group census. Use this map to set new values on the target census, such as the census name or description. | Optional | 68.0 | ## Response Body for POST [Group Census Deep Clone Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_group_census_deep_clone.htm "Output representation of the details that are returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") # deepCloneGroupCensus(groupCensusDeepCloneInputRepresentation, censusId) Clone a group census and its hierarchy, including members, member plans, and plan attributes. Use this method to copy quoting-phase census data into an enrollment-type census, apply field-level overrides, and optionally filter or remap member plan references. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.GroupCensusDeepCloneRepresentation deepCloneGroupCensus(ConnectApi.GroupCensusDeepCloneInputRepresentation groupCensusDeepCloneInputRepresentation, String censusId) ## Parameters **groupCensusDeepCloneInputRepresentation** - Type: [ConnectApi.GroupCensusDeepCloneInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_deep_clone.htm "Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition.") - Details of the clone operation, including optional filters, reference mappings, field overrides, and a custom context definition. **censusId** - Type: String - ID of the source group census to clone. ## Return Value Type: [ConnectApi.GroupCensusDeepCloneRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_group_census_deep_clone.htm "Output representation that's returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") ## Usage Use this method to clone a group census and its hierarchy, including members, member plans, and plan attributes. Specify the source census in censusId. All properties on the input representation are optional. To clone only the member plans that belong to a quote, set quoteId on memberPlanFilter. To remap those plans from quote line items to contract group plans, set contractId on memberPlanReferenceMapping. To stamp new field values on the cloned census, put field API names and values in targetGroupCensusOverrides. To clone the full hierarchy with no filters, mappings, or overrides, pass an empty input representation. The method runs asynchronously. Use the requestId in the response to track the job. Errors that occur while validating or scheduling the job are in the errors property. ## Example This is an example to clone a group census from Apex code. It limits the clone to member plans on a specified quote, remaps those quote line item references to contract group plans, and stamps name and status values on the target census. // Clone a group census hierarchy, optionally filtering member plans, // remapping references, and stamping field values on the target census. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String SOURCE\_QUOTE\_ID = '0Q0xx0000004C92CAE'; final String TARGET\_CONTRACT\_ID = '800xx000000gVN3AAM'; // Optional: scope the clone to one quote's member plans. ConnectApi.MemberPlanFilterInputRepresentation memberPlanFilter = new ConnectApi.MemberPlanFilterInputRepresentation(); memberPlanFilter.quoteId = SOURCE\_QUOTE\_ID; ConnectApi.GroupCensusFiltersInputRepresentation groupCensusFilters = new ConnectApi.GroupCensusFiltersInputRepresentation(); groupCensusFilters.memberPlanFilter = memberPlanFilter; // Optional: remap quote line items to contract group plans. // Provide exactly the direction you want. ConnectApi.MemberPlanReferenceMappingInputRepresentation memberPlanReferenceMapping = new ConnectApi.MemberPlanReferenceMappingInputRepresentation(); memberPlanReferenceMapping.contractId = TARGET\_CONTRACT\_ID; ConnectApi.GroupCensusReferenceMappingsInputRepresentation groupCensusReferenceMappings = new ConnectApi.GroupCensusReferenceMappingsInputRepresentation(); groupCensusReferenceMappings.memberPlanReferenceMapping = memberPlanReferenceMapping; ConnectApi.GroupCensusDeepCloneInputRepresentation input = new ConnectApi.GroupCensusDeepCloneInputRepresentation(); input.groupCensusFilters = groupCensusFilters; input.groupCensusReferenceMappings = groupCensusReferenceMappings; input.targetGroupCensusOverrides = new Map{ 'Name' => 'Apex DeepClone Census', 'Status' => 'Draft' }; // input.contextDefId = 'My\_Custom\_DeepClone\_ContextDef'; // optional try { ConnectApi.GroupCensusDeepCloneRepresentation result = ConnectApi.GroupBenefitsApi.deepCloneGroupCensus(input, CENSUS\_ID); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while cloning the group census: ' + e.getMessage()); } This example clones the full hierarchy with no filters, mappings, or overrides. // Clone the full census hierarchy with no filters, mappings, or overrides. final String CENSUS\_ID = '0rfxx000000022IAAQ'; ConnectApi.GroupCensusDeepCloneInputRepresentation input = new ConnectApi.GroupCensusDeepCloneInputRepresentation(); try { ConnectApi.GroupCensusDeepCloneRepresentation result = ConnectApi.GroupBenefitsApi.deepCloneGroupCensus(input, CENSUS\_ID); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while cloning the group census: ' + e.getMessage()); } # Delete Claim Coverage Payment Detail Output representation for the deleted claim coverage payment detail. ## JSON Example { "isSuccess": true, "paymentDetailId": "0l2xx000000003gEAA", "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | List of errors that are associated with the API operation. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the operation was successful (true)or not (false). | Big, 65.0 | 65.0 | | payment​DetailId | String | ID of the claim coverage payment detail record whose status is marked as Deleted. | Big, 65.0 | 65.0 | # Delete Claim Coverage Payment Detail (POST) Remove unpaid claim coverage payment details by updating the status to Deleted. The API reverses the insurance policy limit tracking data to roll back consumption for the type Loss. ## Resource {claimId}, {coverageId}, and {paymentDetailId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/delete ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/delete ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim whose coverage payment detail must be deleted. | Required | 65.0 | | coverageId | String | ID of the claim coverage record. | Required | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | Required | 65.0 | ## Response Body for POST [Delete Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_delete_claim_coverage_payment_detail.htm "Output representation for the deleted claim coverage payment detail.") # Delete Claim Coverage Payment Detail Action Remove unpaid claim coverage payment details by updating the status of the claim coverage payment detail record to Deleted. When the coveragePaymentType is Loss, this action reverses the insurance policy limit tracking data to roll back consumption. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/deleteClaimCvrPaymentDetail Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | deleteClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex [ConnectApi.DeleteClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_delete_claim_cvr_pymt_dtl_input_re.htm "Input representation for deleting claim coverage payment detail operations") record that contains the details of the claim coverage payment detail record to be marked for deletion by updating the status. | ## Outputs | Output | Type | Description | | --- | --- | --- | | paymentDetailId | string | ID of the payment detail record that's deleted. | ## Example Sample Request { "inputs": \[ { "deleteClaimCvrPymtDtlInputRep": { "claimId": "0Zkxx000000001dEAA", "coverageId": "0kPxx000000002fEAA", "paymentDetailId": "5pdS70000004oVfIAI" } } \] } Sample Response \[ { "actionName": "deleteClaimCvrPaymentDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "paymentDetailId": "5pdS70000004oVfIAI" }, "sortOrder": -1, "version": 1 } \] # Delete Member Plans Output representation for the member plan deletion process. ## JSON Example { "errors": \[\], "isSuccess": true, "memberId": "0r6p00000004C9wAAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors occurred during the API operation. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API executed successfully (true) or not (false). | Small, 65.0 | 65.0 | | memberId | String | ID of the group census member. | Small, 65.0 | 65.0 | # Delete Member Plans Input Input representation for deleting the insurance plans for a census member. ## JSON Example { "plans": { "values": \[ "0rgSG0000000eALYAY", "0rgSG0000000e8jYAA" \] } } ## Properties
Name Type Description Required or Optional Available Version
plans String[] List of group census member plan IDs to delete.

If you specify the root plan ID, all the associated details will be deleted.

 Required 65.0
# DeleteClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId) Delete a claim coverage payment detail record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.DeleteClaimCoveragePaymentDetailRep DeleteClaimCoveragePaymentDetail(String claimId, String coverageId, String paymentDetailId) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage record. **paymentDetailId** - Type: String - ID of the claim coverage payment detail record. ## Return Value Type: [ConnectApi.DeleteClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_delete_claim_coverage_payment_detail.htm "Output representation for the Delete Claim Coverage Payment Detail resource.") ## Example Use the DeleteClaimCoveragePaymentDetailCallable Apex class to delete an existing claim coverage payment detail record for a specified claim and coverage. **Class Definition** public with sharing class DeleteClaimCoveragePaymentDetailCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'deleteClaimCoveragePaymentDetail') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); String claimCoveragePaymentDetailId = (String) inputMap.get('claimCoveragePaymentDetailId'); System.debug('Start of connect API call to delete claim coverage payment detail'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); System.debug('Claim Coverage Payment Detail ID: ' + claimCoveragePaymentDetailId); // Initialize the output representation ConnectApi.DeleteClaimCoveragePaymentDetailRep paymentDetailData; // Call the Connect API to delete claim coverage payment detail try { // Call the Connect API resource directly using the correct method signature // The endpoint is: /connect/insurance/claims/${claimId}/coverages/${coverageId}/payment-details/${paymentDetailId}/delete paymentDetailData = ConnectApi.InsuranceClaimFamily.deleteClaimCoveragePaymentDetail( claimId, claimCoverageId, claimCoveragePaymentDetailId ); System.debug('Claim coverage payment detail deleted successfully: ' + paymentDetailData); // Put the payment detail data in the output map outputMap.put('paymentDetailData', paymentDetailData); outputMap.put('isDeleted', paymentDetailData.isSuccess); // Check if there are any errors if (paymentDetailData.errors != null && !paymentDetailData.errors.isEmpty()) { outputMap.put('errors', paymentDetailData.errors); System.debug('Errors found: ' + paymentDetailData.errors); } } catch (Exception e) { System.debug('Error while deleting claim coverage payment detail: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isDeleted', false); } // Return the payment detail data return paymentDetailData; } // If the action is not recognized, return null return null; } } **Usage Example** DeleteClaimCoveragePaymentDetailCallable callable = new DeleteClaimCoveragePaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0ZkXK00000000010AA'); // Claim ID input.put('claimCoverageId', '0kPXK00000000012AA'); // Claim Coverage ID input.put('claimCoveragePaymentDetailId', '0l2XK000000006TYAQ'); // Claim Coverage Payment Detail ID // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'deleteClaimCoveragePaymentDetail' action Object result = callable.call('deleteClaimCoveragePaymentDetail', args); // Check the result if (result != null) { System.debug('Claim coverage payment detail processed successfully: ' + result); // Access the processed payment detail data ConnectApi.DeleteClaimCoveragePaymentDetailRep paymentDetailData = (ConnectApi.DeleteClaimCoveragePaymentDetailRep) result; // Process the result as needed System.debug('Payment Detail Data: ' + paymentDetailData); // Check if the payment was successful if (paymentDetailData.isSuccess) { System.debug('Deletion was successful'); } else { System.debug('Deletion failed'); if (paymentDetailData.errors != null) { System.debug('Error details: ' + paymentDetailData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # deleteInsuranceDeleteAllMembers(groupCensusId) Delete all census members for the specified group census ID. ## API Version 65.0 ## Requires Chatter No ## Signature public static void deleteInsuranceDeleteAllMembers(String groupCensusId) ## Parameters **groupCensusId** - Type: String - ID of the group census whose members must be deleted. ## Return Value Type: [ConnectApi.InsuranceCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_mgmt.htm "Output representation for the insurance census management process.") # Edit Claim Coverage Payment Detail Action Modify a claim coverage payment detail record. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/editClaimCvrPaymentDetail Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | editClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex ConnectApi.EditClaimCvrPymtDtlInputRep record that contains details of the claim coverage payment detail to edit. | ## Outputs | Output | Type | Description | | --- | --- | --- | | editClaimCvrPymtDtlOutputRep | Apex-defined | An Apex ConnectApi.EditClaimCvrPymtDtlOutputRep record that contains details of the claim coverage payment detail that’s edited. | ## Example **POST** This sample request is for the Edit Claim Coverage Payment Detail action. { "inputs": \[ { "editClaimCvrPymtDtlInputRep": { "claimId": "0Zkxx0000000001CAA", "claimCoverageId": "0kPxx0000000001CAA", "claimCoveragePaymentDetailId": "0l2xx0000000001CAA", "claimedAmount": 5000, "adjustedAmount": 5000, "recipientId": "001xx000003DGQyAAO", "name": "Rental Car Expense", "description": "Payment for 5 days of rental car usage", "limitUnitCount": 5, "status": "Draft", "additionalFields": \[ { "key": "State", "value": "CA" }, { "key": "LOB\_\_c", "value": "Commercial" } \] } } \] } This sample response is for the Edit Claim Coverage Payment Detail action. { "actionName": "editClaimCvrPaymentDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "editClaimCvrPymtDtlOutputRep": { "isSuccess": true, "adjustedAmount": 200, "adjustedReason": "Deductible", "insPolicyLimitTrackingIds": \[ "1TExx0000004DUuGAM", "1TExx0000004DUvGAM" \], "errors": \[\] } }, "sortOrder": -1, "version": 1 } # Edit Claim Coverage Payment Detail Input Details to edit a claim coverage payment detail record. ## JSON Example { "claimedAmount": 5000.00, "adjustedAmount": 5000.0, "recipientId": "001xx000003DGQyAAO", "name": "Rental Car Expense", "description": "Payment for 5 days of rental car usage", "limitUnitCount": 5, "status": "Draft", "additionalFields": { "State": "CA", "policyType": "Auto", "LOB\_\_c": "Personal" } } ## Properties
Name Type Description Required or Optional Available Version
additionalFields Object Additional standard or custom fields that are used to update the claim coverage payment detail. Optional 66.0
adjustedAmount Double Adjusted amount of the claim. Required if claimedAmount is specified for a loss item. 66.0
claimedAmount Double Amount requested by the claimant when submitting the loss. Optional 66.0
description String Description of the claim line item. Optional 66.0
limitUnitCount Integer Number of units for this claim coverage payment detail, such as the number of days for a rental car expense. The default value is 1. Optional 66.0
name String Name of the claim coverage payment detail record. Optional 66.0
recipientId String ID of the person or entity who will receive the payment, such as the policyholder, a third-party claimant, or a service vendor.

For a Loss item, the recipient is the policyholder or a third party. For an Expense item, the recipient ID represents a vendor or internal staff member.

 Optional 66.0
status String Current status of the claim coverage payment detail, such as Draft. Optional 66.0
# Edit Claim Coverage Payment Detail Response Output representation for the edited claim coverage payment detail. ## JSON Example { "adjustedAmount": 4500.00, "adjustedReason": "Deductible applied", "insurancePolicyLimitTrackingIds": \[ "0qOxx0000004CvQEAU", "0qOxx0000004CvREAU" \], "isSuccess": true, "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | adjustedAmount | Double | Final amount after all deductions, such as deductibles or co-pays. This field is returned when a Loss item is created and adjustments are applied. | Big, 65.0 | 65.0 | | adjustedReason | String | Reason for the claim coverage payment detail adjustment, such as deductible, copay, or coinsurance. | Big, 65.0 | 65.0 | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Errors details when the operation fails. | Big, 65.0 | 65.0 | | insurance​PolicyLimitTracking​Ids | String\[\] | Comma-separated IDs of the insurance policy limit tracking records. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # EditClaimCoveragePaymentDetail(EditClaimCoveragePaymentDetailInput, claimId, coverageId, paymentDetailId) Modify a claim coverage payment detail record. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.EditClaimCoveragePaymentDetailRep EditClaimCoveragePaymentDetail(ConnectApi.EditClaimCvrPaymentDetailInputRep EditClaimCoveragePaymentDetailInput, String claimId, String coverageId, String paymentDetailId) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the coverage that applies to the claim. **EditClaimCoveragePaymentDetailInput** - Type: [ConnectApi.EditClaimCvrPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_edit_claim_cvr_payment_detail.htm "Input representation for editing claim coverage payment detail.") - Details to edit the claim coverage payment detail. **paymentDetailId** - Type: String - ID of the claim coverage payment detail. ## Return Value Type: [ConnectApi.EditClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_edit_claim_coverage_payment_detail.htm "Output representation for editing claim coverage payment detail.") ## Example **Class Definition** This is a sample Apex code to define the EditClaimCoveragePaymentDetail class before you can call it from Apex to edit a claim coverage payment detail. public with sharing class EditClaimCoveragePaymentDetailCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'editClaimCoveragePaymentDetail') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); String paymentDetailId = (String) inputMap.get('paymentDetailId'); ConnectApi.EditClaimCvrPaymentDetailInputRep editInputRep = (ConnectApi.EditClaimCvrPaymentDetailInputRep) inputMap.get('EditClaimCoveragePaymentDetailInput'); System.debug('Start of connect API call to edit claim coverage payment detail'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); System.debug('Payment Detail ID: ' + paymentDetailId); // Initialize the output representation ConnectApi.EditClaimCoveragePaymentDetailRep editResponse; // Call the Connect API to edit claim coverage payment detail try { // Call the Connect API resource directly // The endpoint is: /connect/insurance/claims/${claimId}/coverages/${coverageId}/payment-details/${paymentDetailId} editResponse = ConnectApi.InsuranceClaimFamily.EditClaimCoveragePaymentDetail( editInputRep, claimId, claimCoverageId, paymentDetailId ); System.debug('Edit claim coverage payment detail completed successfully: ' + editResponse); // Put the editResponse in the output map outputMap.put('editResponse', editResponse); outputMap.put('isSuccess', editResponse.isSuccess); // Check if there are any errors if (editResponse.errors != null && !editResponse.errors.isEmpty()) { outputMap.put('errors', editResponse.errors); System.debug('Errors found: ' + editResponse.errors); } } catch (Exception e) { System.debug('Error while editing claim coverage payment detail: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isSuccess', false); } return editResponse; } // If the action is not recognized, return null return null; } } **Usage Example** This example shows how to call the EditClaimCoveragePaymentDetailCallable class and include the required input data. PayExGratiaClaimCvrPaymentDetailCallable callable = new PayExGratiaClaimCvrPaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0ZkSB0000001AVH0A2'); // Claim ID input.put('claimCoverageId', '0kPSB000000GHdu2AG'); // Claim Coverage ID input.put('paymentDetailId', '0l2SB000000CLsMYAW'); // Payment Detail ID // Create the input representation object // First create a Map with the properties Map payExGratiaInputMap = new Map(); payExGratiaInputMap.put('reason', 'Customer service goodwill payment'); // Convert the Map to ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep using JSON.deserialize String jsonString = JSON.serialize(payExGratiaInputMap); ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep payExGratiaInputRep = (ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep) JSON.deserialize(jsonString, ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep.class); input.put('PayExGratiaClaimCvrPaymentDetailInput', payExGratiaInputRep); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'payExGratiaClaimCvrPaymentDetail' action Object result = callable.call('payExGratiaClaimCvrPaymentDetail', args); // Check the result if (result != null) { System.debug('payExGratiaClaimCvrPaymentDetail processed successfully: ' + result); // Access the processed payment data ConnectApi.PayExGratiaClaimCvrPaymentDetailRep paymentData = (ConnectApi.PayExGratiaClaimCvrPaymentDetailRep) result; // Process the result as needed System.debug('Pay Ex Gratia Payment Data: ' + paymentData); // Check if the payment was successful if (paymentData.isSuccess) { System.debug('Pay Ex Gratia was successful'); System.debug('Paid Amount: ' + paymentData.paidAmount); System.debug('Claim Payment Summary ID: ' + paymentData.claimPaymentSummaryId); System.debug('Consumed Limit Count: ' + paymentData.consumedLimitCount); System.debug('Exceeded Amount: ' + paymentData.exceededAmount); System.debug('Exceeded Count: ' + paymentData.exceededCount); if (paymentData.insPolicyLimitTrackingIds != null && !paymentData.insPolicyLimitTrackingIds.isEmpty()) { System.debug('Insurance Policy Limit Tracking IDs: ' + paymentData.insPolicyLimitTrackingIds); } } else { System.debug('Pay Ex Gratia failed'); if (paymentData.errors != null) { System.debug('Error details: ' + paymentData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # Eligible Plan Details Output representation for the details of the eligible plans. ## JSON Example { "messages": \[ { "message": "Plan eligibility evaluated successfully.", "messageType": "INFO" } \], "plans": \[ { "planId": "8ckxx000000000001", "planName": "Group Medical Plan", "productCategory": "Medical", "isOptional": false, "attributes": \[ { "entries": \[ { "key": "AGE\_BAND", "value": "18-25" } \] } \], "coverages": \[ { "planId": "8ckxx000000000002", "planName": "Dental Coverage", "productCategory": "Dental", "isOptional": true, "attributes": \[\], "uiTreatments": \[ { "uiTreatmentType": "disable", "uiTreatmentTarget": "attribute\_picklist\_value", "details": { "planId": "8ckxx000000000002", "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "0", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceZero", "attributePicklistValueId": "0v6xx000000000SAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "10", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceTen", "attributePicklistValueId": "0v6xx000000000TAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" } \] } \], "uiTreatments": \[ { "details": { "attributeId": "0tjxx000000000cAAA", "attributeCode": "onmedFees", "stiId": "ref\_875915aa\_61c4\_4916\_ae58\_9fa7e0dec529", "attributeName": "Out-Network ICU Fees" }, "uiTreatmentTarget": "attribute", "uiTreatmentType": "hide" } \] } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | messages | [Insurance Message](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_message_output.htm "Output representation of an insurance message, which can be informational or an error.")\[\] | List of informational or error messages related to the eligibility check. | Small, 66.0 | 66.0 | | plans | [Insurance Group Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_plan_output.htm "Output representation of an insurance group plan.")\[\] | List of contract group plans that the member is eligible for. | Small, 66.0 | 66.0 | # Endorse Contract (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 along with their associated attributes based on the finalized endorsement quote, and links both versions. ## Resource /connect/insurance/contracts/actions/endorse ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/actions/endorse ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000004CtoCAE", "effectiveDate": "2026-02-01", "updateExistingContractDates": false, "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to add to contract items. | Optional | 68.0 | | effectiveDate | String | Effective date of endorsement that indicates the start date of the endorsed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | quoteId | String | ID of the quote for contract endorsement. | Required | 68.0 | | updateExistingContractDates | Boolean | Indicates whether to update dates on the existing contract when creating the endorsed contract version ( true) or not ( false). | Optional | 68.0 | ## Response Body for POST [Contract Endorsement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_endorse.htm "Output representation of the details when an endorsed contract version is created from a quote.") # Endorse Contract Action Create an endorsed contract version from an existing contract based on the quote for mid-term adjustments. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/endorseContract Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | insuranceContractEndorseInputRepresentation | Apex-defined | Required. An Apex ConnectApi.InsuranceContractEndorseInputRepresentation record that contains the details to endorse an insurance contract. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insuranceContractEndorseOutputRepresentation | Apex-defined | An Apex ConnectApi.InsuranceContractEndorseRepresentation record that contains the status of the action, any error messages, and the ID of the endorsed contract. | ## Example **POST** This sample request is for the Endorse Contract action. { "inputs": \[ { "insuranceContractEndorseInputRepresentation": { "quoteId": "0Q0xx0000004CtoCAE", "effectiveDate": "2026-02-01", "updateExistingContractDates": false, "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } } \] } This sample response is for the Endorse Contract action. \[ { "actionName": "endorseContract", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insuranceContractEndorseOutputRepresentation": { "errors": \[\], "isSuccess": true, "message": "Contract was created from the quote", "contractId": "800xx0000004C92AAE" } }, "sortOrder": -1, "version": 1 } \] # Endorse Insurance Brokerage Policy Action Complete an in-progress endorsement of an insurance brokerage policy. This action is available in API version 67.0 and later. ## Special Access Rules The Endorse Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/endorseInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_EndorseBrokeragePolicyIAInputRep record that contains the ID of the insurance brokerage policy to endorse. | ## Outputs | Output | Type | Description | | --- | --- | --- | | transactionId | string | Transaction ID that's generated during the policy endorsement process. | ## Example **POST** This sample request is for the Endorse Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for endorsing a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('endorseInsBrokeragePolicy'); // Instantiate the input object ConnectApi.EndorseBrokeragePolicyIAInputRep input = new ConnectApi.EndorseBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the brokerage policy to be endorsed input.policyId = '0YjXX0000000001'; // Set the invocation parameter and invoke action.setInvocationParameter('endorseBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Endorse Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Endorse Insurance Brokerage Policy action. \[ { "actionName": "endorseInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "transactionId": "txn\_abc123def456" }, "sortOrder": -1, "version": 1 } \] # Endorse Insurance Policy (POST) Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the request body. If you want to calculate billing during insurance policy endorsement process, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/endorse ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx00000000WHGAY/endorse ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "effectiveDate": "2024-01-01", "insurancePolicy": { "policyName": "p2\_endorse\_name", "policyNumber": "p2\_endorse\_number" }, "transactionRecord": { "name": "New Endorsement" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields": { "additionalFieldsList": \[ { "additionalFieldsMapValue": { "instanceKey": "autoRoot", "fields": { "Checkbox\_\_c": "true", "Currency\_\_c": 123456, "Date\_\_c": "2024-11-30", "DateTime\_\_c": "2024-12-31T01:34:00.000Z", "Email\_\_c": "testuser@sf.com" } } }, { "additionalFieldsMapValue": { "instanceKey": "autoDriver", "fields": { "TextEncr\_\_c": "233345675676", "Url\_\_c": "https://thisistest.com", "Time\_\_c": "12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.") \[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when endorsing the policy. | Optional | 67.0 | | contextId | String | Context ID of the quote that’s used for endorsement. | Required | 63.0 | | effectiveDate | String | Date from when the endorsed policy version is effective. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.") \[\] | JSON structure that overrides the name and policy number of the endorsed policy version. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that overrides the transaction information. | Optional | 63.0 | ## Response Body for POST [Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_output.htm "Output representation of policy details.") # Endorse Insurance Policy Action Endorse an insurance policy by using a set of user inputs that represent policy details. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/endorseInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Details
endorsePolicyIAInputRep Type

Apex-defined

Description

An Apex ConnectApi.EndorsePolicyIAInputRep record that contains the details of the policy to be endorsed. To calculate billing, specify billingRecord details if Career Billing is enabled in your org.
## Outputs
Output Details
endorsedPolicyId Type

String

Description

ID of the endorsed insurance policy.
## Example Sample Request. { "inputs": \[ { "EndorsePolicyIAInputRep": { "contextId": "5dbc40312f69b2d8cb4e7042a700d06f32fc5b9df7de3eabc94aa19a66ed77b3", "policyId": "0YTxx00000001IfGAI", "effectiveDate" : "2024-06-06", "insurancePolicy": { "policyName": "Endorsed Test Auto Ins policy", "policyNumber": "PLC5678987" }, "transactionRecord": { "name": "Endorsed Policy Transaction" }, "billingRecord":{ "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key":"AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key":"SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList":\[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key":"Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key":"PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } Sample Response \[ { "actionName": "endorseInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "endorsedPolicyId": "0YTSG000000PgVV4A0" }, "sortOrder": -1, "version": 1 } \] # Endorse Multi-Root Insurance Policy Action Create an endorsement for an existing multi-root insurance policy to apply updates or changes to the policy and its associated child policies. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/endorseMultiRootInsPolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | endorseMultiRootPolicyInputRep | Apex-defined | Required. An Apex ConnectApi.EndorseMultiRootPolicyInputRep record that contains the details of the policy to be endorsed. To calculate billing, specify billingRecord details if Career Billing is enabled in your org. | ## Outputs | Output | Type | Description | | --- | --- | --- | | jobIdentifier | string | A unique system-generated ID for the job that processes the endorsement of the multi-root insurance policy. | ## Example **POST** This sample request is for the Endorse Multi-Root Insurance Policy action. { "inputs": \[ { "endorseMultiRootPolicyInputRep": { "contextId": "5dbc40312f69b2d8cb4e7042a700d06f32fc5b9df7de3eabc94aa19a66ed77b3", "policyId": "0YTxx00000001IfGAI", "effectiveDate": "2024-06-06", "insurancePolicy": { "policyName": "Endorsed Test Auto Ins policy", "policyNumber": "PLC5678987" }, "transactionRecord": { "name": "Endorsed Policy Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key": "AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key": "SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList": \[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key": "Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key": "PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } This is a sample code to call the Endorse Multi-Root Insurance Policy action from Apex. public with sharing class MultiRootPolicyEndorsementInvocable { /\*\* \* Execute Multi-Root Policy Endorsement with parameters map \* Usage: MultiRootPolicyEndorsementInvocable.executeMultiRootEndorsement(paramsMap); \* \* @param params Map of parameters: \* - contextId (String, REQUIRED) \* - policyId (String, REQUIRED) \* - effectiveDate (String, REQUIRED) \* - policyName (String, optional) \* - policyNumber (String, optional) \* - transactionName (String, optional) \* - additionalFields (Map>, optional) \*/ public static void executeMultiRootEndorsement(Map params) { // Extract and validate contextId (REQUIRED) String contextId = (String) params.get('contextId'); if (String.isBlank(contextId)) { System.debug('ERROR: contextId is required'); return; } // Extract and validate policyId (REQUIRED) String policyId = (String) params.get('policyId'); if (String.isBlank(policyId)) { System.debug('ERROR: policyId is required'); return; } // Extract and validate effectiveDate (REQUIRED) String effectiveDate = (String) params.get('effectiveDate'); if (String.isBlank(effectiveDate)) { System.debug('ERROR: effectiveDate is required'); return; } // Multi-Root Endorse Policy IA - Create the standard Invocable Action Invocable.Action action = Invocable.Action.createStandardAction('endorseMultiRootInsPolicy'); // Instantiate the IA input object for Multi-Root Policy Endorsement // IMPORTANT: Use EndorseMultiRootPolicyInputRep, NOT EndorsePolicyIAInputRep ConnectApi.EndorseMultiRootPolicyInputRep policyInput = new ConnectApi.EndorseMultiRootPolicyInputRep(); // Set context ID (REQUIRED) policyInput.contextId = contextId; // Set policy ID (REQUIRED) policyInput.policyId = policyId; // Set effectiveDate (REQUIRED) policyInput.effectiveDate = effectiveDate; // Extract optional parameters String policyName = (String) params.get('policyName'); String policyNumber = (String) params.get('policyNumber'); String transactionName = (String) params.get('transactionName'); Map> additionalFields = (Map>) params.get('additionalFields'); // Populate Insurance Policy details (using IA classes) - all optional if (!String.isBlank(policyName) || !String.isBlank(policyNumber)) { ConnectApi.InsPolicyIAInputRep insurancePolicy = new ConnectApi.InsPolicyIAInputRep(); if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(policyNumber)) { insurancePolicy.policyNumber = policyNumber; } policyInput.insurancePolicy = insurancePolicy; } // Populate Transaction record (using IA transaction representation) - optional if (!String.isBlank(transactionName)) { ConnectApi.InsPolicyTrxnIAInputRep transactionRecord = new ConnectApi.InsPolicyTrxnIAInputRep(); transactionRecord.name = transactionName; policyInput.transactionRecord = transactionRecord; } // Populate additional input for multi-root policies - optional if (additionalFields != null && !additionalFields.isEmpty()) { List additionalInputList = new List(); for (String instanceKey : additionalFields.keySet()) { ConnectApi.InsPolicyAddlInputIARep additionalInput = new ConnectApi.InsPolicyAddlInputIARep(); // Set instance key (e.g., "AutoSilver", "familyHealth") additionalInput.instanceKey = instanceKey; // Build additional fields list for this instance Map fieldsMap = additionalFields.get(instanceKey); if (fieldsMap != null && !fieldsMap.isEmpty()) { List fieldsList = new List(); for (String fieldKey : fieldsMap.keySet()) { ConnectApi.AdditionalFieldIARep field = new ConnectApi.AdditionalFieldIARep(); field.key = fieldKey; field.value = fieldsMap.get(fieldKey); fieldsList.add(field); } additionalInput.additionalFieldsList = fieldsList; } additionalInputList.add(additionalInput); } policyInput.additionalInput = additionalInputList; } // Set invocation parameters // IMPORTANT: Parameter name is endorseMultiRootPolicyInputRep (camelCase) action.setInvocationParameter('endorseMultiRootPolicyInputRep', policyInput); System.debug('Starting Multi-Root Policy Endorsement Invocable Action (endorseMultiRootInsPolicy)...'); System.debug('Context ID: ' + contextId); if (!String.isBlank(policyName)) { System.debug('Policy Name: ' + policyName); } try { // Invoke the action List results = action.invoke(); System.debug('Multi-Root Policy Endorsement IA result = ' + results); // Process results for (Invocable.Action.Result result : results) { if (result.isSuccess()) { System.debug('SUCCESS: Multi-Root Policy Endorsement completed successfully!'); Object outputValue = result.getOutputParameters().get('jobIdentifier'); if (outputValue != null) { System.debug('Job Identifier: ' + outputValue); } else { System.debug('Multi-Root Policy Endorsement job started - result: ' + result.getOutputParameters()); } } else { System.debug('ERROR: Multi-Root Policy Endorsement failed'); System.debug('Error Details: ' + result.getErrors()); } } } catch (Exception e) { System.debug('EXCEPTION in Multi-Root Policy Endorsement Invocable Action: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); } } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ Map params = new Map(); params.put('contextId', '0000000i18tq18g002917629276616310d09368a7cb24db687f6fd95af4b9954'); params.put('policyId', '0YTSM0000001MzN4AU'); params.put('policyName', 'James Multi-Root Policy Apex IA'); params.put('effectiveDate', '2026-08-01'); params.put('transactionName', 'Endorsement Second'); // Build additional fields configuration Map> additionalFields = new Map>(); // Configuration for AutoSilver instance Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy IA Apex'); autoFields.put('Name', 'James Auto Policy'); additionalFields.put('AutoSilver', autoFields); // Configuration for FamilyHealth instance Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy IA Apex'); healthFields.put('Name', 'James Medical Policy'); healthFields.put('Email\_\_c', 'medical@james.co'); additionalFields.put('familyHealth', healthFields); params.put('additionalFields', additionalFields); MultiRootPolicyEndorsementInvocable.executeMultiRootEndorsement(params); This sample response is for the Endorse Multi-Root Insurance Policy action. \[ { "actionName": "endorseMultiRootInsPolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "jobIdentifier": "750x00000000001AAA" }, "sortOrder": -1, "version": 1 } \] # Endorse Multi-Root Policy Modifies an active multi-root insurance policy by creating new versions of the parent policy and all child policies, regardless of which child policy is changed. The resulting policy versions include recalculated standard and prorated premiums based on the endorsement effective date. Make sure you have these details before endorsing a multi-root policy - The Policy ID of the active parent insurance policy to be endorsed. - The Pricebook ID required to generate the endorsement quote. - Details of the modifications to apply to the policy, such as coverages to add or remove and updated limit amounts. - For multi-root quotes configured through the Quote UI, click the Reprice All button on the Transaction Line Item Table (TLT) after all products are configured to ensure pricing and aggregate amounts are correctly reflected at the quote level. 1. Get Policy Context—Retrieve the policy context by using the policy ID through one of the following methods: - Make a GET request to the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm) Connect API. - Use the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm) invocable action. 2. Create Endorsement Quote—Use the policy context to create the endorsement quote container by using one of the following methods: - Make a POST request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) Connect API. - Use the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm) invocable action. Specify the contextId and pricebookId during the API call. Creates an endorsement quote associated with the active policy. After the policyholder confirms the updated quote price, proceed with the next steps in the endorsement workflow. 3. Create or Update Quote (PATCH)—Configure and price the endorsement changes by making a PATCH request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm) API using the quoteId and user inputs. ![Note](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/images/icon_note.png) #### Note For multi-root policies, ensure pricing is recalculated across all root products to accurately compute aggregate totals and prorated term premiums. 4. Endorse Multi-Root Policy—Use the updated context to endorse the policy by using one of the following methods: - Make a POST request to the [Multi-Root Policy Endorsement](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_multi_root_endorsement_policy.htm) Connect API. - Use the [Endorse Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_multi_root_insurance_policy.htm) invocable action. - Returns an Async Request ID in the response to track the job status. - Creates a new version of the parent policy and all associated child policies. - Recalculates standard and prorated premiums based on the endorsement effective date and rolls them up to the parent policy. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. - Generates transaction records that document the financial impact of the endorsement. # Endorse Multi-Root Policy Perform a mid-term adjustment on an active multi-root policy when pricing is handled through the Rating API instead of a Salesforce Quote. This process bypasses the creation of a Quote record while ensuring accurate pricing and versioned updates to the parent and child policies. Make sure you have these details before endorsing a multi-root policy: - The Policy ID of the active parent insurance policy to be endorsed. - Details of the modifications to apply to the policy. 1. Get Policy Context—Retrieve the policy context by using the policy ID through one of the following methods: - Make a GET request to the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm) Connect API. - Use the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm) invocable action. Returns the context required to evaluate and price the endorsement changes. 2. Generate Price-Adjusted Context—Generate a priced context for the proposed changes by making a PATCH request to the [Insurance Product Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API using the context ID. Returns a price-adjusted context that contains the premium impact of the proposed modifications. 3. (Optional) Run Qualification Rules—Determine eligibility for the proposed changes by making a POST request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) Connect API with saveQuote=false. Returns an updated context containing eligibility results without saving a Quote record. 4. Endorse Multi-Root Policy—Use the updated context to endorse the policy by using one of the following methods: - Make a POST request to the [Multi-Root Policy Endorsement](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_multi_root_endorsement_policy.htm) Connect API. - Use the [Endorse Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_multi_root_insurance_policy.htm) invocable action. - Returns an Async Request ID in the response to track the job status. - Creates new versions of the parent policy and all associated child policies with updated effective dates and premiums. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. - Completes the operation asynchronously and notifies the user upon success or failure. # Endorse Policy Policy endorsement, also known as Mid-Term Adjustment (MTA), is the process of making modifications to an active insurance policy during its term. Common modifications include adding or removing coverage, or updating policy attributes, such as limits and deductibles. Endorsements usually affect the policy price and create a new policy version instead of updating the existing record. This new version includes the applied changes, along with a recalculated standard premium. It also contains a prorated term premium that’s calculated based on the effective date of the endorsement. Make sure you have these details. - Policy ID of the active insurance policy to be endorsed. - Pricebook ID is a required input for generating an endorsement quote. - Details of the modifications to be made to the policy, such as specific coverages to add or remove, and new limit amounts. This diagram outlines the sequence of endorsing a policy, where any changes are initially processed through a quote to assess the pricing impact. ![A flow diagram representing the sequence of endorsing a policy based on a quote.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/endorse_policy_with_salesforce_quote.png) 1. **Get Policy Context**—Use the policy ID to get the context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Create Endorsement Quote**—Use the policy context to create the endorsement quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Specify the contextId and pricebookId during the API call. You can update the header-level fields of the quote, such as the quote name or effective date for the endorsement, by specifying these values as the input parameters during the API call. A new quote record is generated for the endorsement. After the policyholder confirms the updated quote price, proceed with the next steps in the endorsement workflow. 3. **(Optional)Modify Endorsement Quote**—If policyholders want to modify the endorsement quote, make a PATCH request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API with the required changes. An updated, price-adjusted context is returned in the response. 4. **Endorse Policy**—Use the retrieved context to endorse a policy either by: - Making a POST request on the [Endorse Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_endorse_policy.htm "HTML (New Window)") Connect API, or - Using the [Endorse Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_insurance_policy.htm "HTML (New Window)") invocable action. You can change the context fields, such as the policy name or policy number, directly during the API call. You can also provide a name for the transaction record that's created along with the endorsement. This transaction record documents the financial details and audit information associated with the MTA. A new endorsed policy version is created. **Expected Results:** - A new policy version record is created in Salesforce, which includes the endorsed changes. - A new policy version is created with an updated effective-from date. The effective-to date of the existing policy version is adjusted to an end date just before the new version begins, ensuring continuous but non-overlapping coverage. - The new policy version has the updated premium information, including the new standard premium and the prorated term premium, accurately calculated and stored. - A transaction record is created and linked to the endorsement activity. # Endorse Policy Policy endorsement, also known as a Mid-Term Adjustment (MTA), is a process where you change an active insurance policy. The endorsement process changes the policy version and the premiums. This user journey shows you how to endorse a policy when Salesforce's quoting capabilities aren't used. Make sure you have these details. - Policy ID of the active insurance policy to be endorsed. - Details of the modifications to be made, such as changes to coverages, limits, and deductibles. This diagram outlines the sequence of endorsing a policy, where any changes are initially processed through the Rating API to generate a price-adjusted context. The context contains the calculated premium and other relevant details that are required to endorse the policy. This process bypasses the need for a formal Salesforce Quote record for pricing. ![A flow diagram representing the user journey for endorsing a policy by using the Rating API.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/endorse_policy_without_quote.png) 1. **Get Policy Context**—Use the policy ID to get the policy context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Generate Price-adjusted Context**—Use the context ID and make a PATCH request on the [Insurance Product Ratings](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API. The price-adjusted context record contains the premium impact of the proposed modifications. 3. **(Optional)Run Qualification Rules**—If customers want to determine the policyholder’s eligibility for a product, run the qualification rules either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Set the saveQuote parameter to false. It doesn't save the quote and returns an updated context with the eligibility details. 4. **Endorse Policy**—Use the retrieved context to endorse a policy either by: - Making a POST request on the [Endorse Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_endorse_policy.htm "HTML (New Window)") Connect API, or - Using the [Endorse Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_insurance_policy.htm "HTML (New Window)") invocable action. You can change the context fields, such as the policy name or policy number, directly during the API call. You can also provide a name for the transaction record that's created along with the endorsement. This transaction record captures the financial details or the audit information related to the MTA. A new endorsed policy version is created. **Expected Results:** - A new policy version record is created in Salesforce, which includes the endorsed changes. - A new policy version is created with an updated effective-from date. The effective-to date of the existing policy version is adjusted to an end date just before the new version begins, ensuring continuous but non-overlapping coverage. - The new policy version has the updated premium information, including the new standard premium and the prorated term premium, accurately calculated and stored. - A transaction record is created and linked to the endorsement activity. # Endorse Policy (POST, PATCH) Create an endorsement policy draft or complete endorsing a policy by using the insurance policy ID. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/endorse ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx0000000001GAA/endorse ## Available Version 67.0 ## HTTP Methods POST, PATCH ## Request Parameters for POST and PATCH | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | policyId | Id | ID of the insurance policy to endorse or create an endorsement draft for. The key prefix is 0YT. | Required | ## Request Body for POST and PATCH ### JSON Example "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 67.0 | ## Response Body for POST [Insurance Policy Draft Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_draft_output.htm "Output representation details of the endorsement draft policy request.") ## Response Body for PATCH [Insurance Policy Issue Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_issue_output.htm "Output representation details of the issue policy and issue endorse policy requests.") # Endorse Policy Input Input representation of endorse policy details. ## JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "effectiveDate": "2024-01-01", "insurancePolicy": { "policyName": "p2\_endorse\_name", "policyNumber": "p2\_endorse\_number" }, "transactionRecord": { "name": "New Endorsement" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields": { "additionalFieldsList": \[ { "additionalFieldsMapValue": { "instanceKey": "autoRoot", "fields": { "Checkbox\_\_c": "true", "Currency\_\_c": 123456, "Date\_\_c": "2024-11-30", "DateTime\_\_c": "2024-12-31T01:34:00.000Z", "Email\_\_c": "testuser@sf.com" } } }, { "additionalFieldsMapValue": { "instanceKey": "autoDriver", "fields": { "TextEncr\_\_c": "233345675676", "Url\_\_c": "https://thisistest.com", "Time\_\_c": "12:05:00.000Z" } } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when endorsing the policy. | Optional | 67.0 | | contextId | String | Context ID of the quote that’s used for endorsement. | Required | 63.0 | | effectiveDate | String | Date from when the endorsed policy version is effective. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that overrides the name and policy number of the endorsed policy version. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.")\[\] | JSON structure that overrides the transaction information. | Optional | 63.0 | # endorseDraftInsurancePolicy(insurancePolicyDraftProcessInput, policyId) Create an endorsement draft for a specific insurance policy by providing the draft input details and the policy ID. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyDraftOutputRepresentation endorseDraftInsurancePolicy(ConnectApi.InsurancePolicyDraftInputRepresentation insurancePolicyDraftProcessInput, String policyId) ## Parameters **insurancePolicyDraftProcessInput** - Type: [ConnectApi.InsurancePolicyDraft​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_draft.htm "Input representation for the endorsement draft request. Includes a field value map that specifies the insurance policy fields to override in the draft.") - Input representation containing the field value map of insurance policy fields to override in the endorsement draft. **policyId** - Type: String - ID of the insurance policy for which to create an endorsement draft. ## Return Value Type: [ConnectApi.InsurancePolicyDraftOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_draft_output.htm "Output representation for the endorsement draft response. Contains the policy ID of the created draft and any errors that occurred during the process.") ## Usage Use this method to create an endorsement draft for a specific insurance policy. Provide a field value map containing the policy fields to override and the ID of the policy. The response includes the policy ID of the created draft and any errors that occurred during the process. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.endorseDraftInsurancePolicy() method to create an endorsement draft for a specific insurance policy. **Class Definition** This Apex example shows how to create an endorsement draft for an insurance policy. global class DraftEndorseConnectDriver { global static void callDraftEndorseConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); ConnectApi.InsurancePolicyDraftInputRepresentation draftInput = new ConnectApi.InsurancePolicyDraftInputRepresentation(); Map fields = new Map(); fields.put('Name', 'Test Apex Draft Endorse'); fields.put('EffectiveDate', '2026-08-01'); draftInput.fieldValueMap = fields; input.put('policyInput', draftInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); DraftEndorseTestConnectAPI callable = new DraftEndorseTestConnectAPI(); Object result = callable.call('draftEndorse', args); ConnectApi.InsurancePolicyDraftOutputRepresentation policyData = (ConnectApi.InsurancePolicyDraftOutputRepresentation) result; System.debug('Draft Endorse Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the DraftEndorseTestConnectAPI class to execute the draftEndorse action and process the result. public class DraftEndorseTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'draftEndorse') { ConnectApi.InsurancePolicyDraftInputRepresentation draftInput = (ConnectApi.InsurancePolicyDraftInputRepresentation) inputMap.get('policyInput'); String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to draft endorse policy: ' + policyId); ConnectApi.InsurancePolicyDraftOutputRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.endorseDraftInsurancePolicy(draftInput, policyId); System.debug('Draft endorsement created successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while creating draft endorsement: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute DraftEndorseConnectDriver.callDraftEndorseConnectAPI(); # endorseInsurancePolicy(policyId) Endorse a specific insurance policy by providing the policy ID. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyIssueOutputRepresentation endorseInsurancePolicy(String policyId) ## Parameters **policyId** - Type: String - ID of the insurance policy to endorse. ## Return Value Type: [ConnectApi.InsurancePolicyIssueOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_issue_output.htm "Output representation for the issue or endorse policy response. Contains the transaction ID and any errors that occurred during the process.") ## Usage Use this method to endorse a specific insurance policy. The endorsement applies pending changes to the policy and generates a transaction. The response includes the transaction ID and any errors that occurred during the endorsement process. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.endorseInsurancePolicy() method to endorse a specific insurance policy. **Class Definition** This Apex example shows how to endorse an insurance policy. global class EndorseConnectDriver { global static void callEndorseConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); EndorseTestConnectAPI callable = new EndorseTestConnectAPI(); Object result = callable.call('endorse', args); ConnectApi.InsurancePolicyIssueOutputRepresentation policyData = (ConnectApi.InsurancePolicyIssueOutputRepresentation) result; System.debug('Endorse Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the EndorseTestConnectAPI class to execute the endorse action and process the result. public class EndorseTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'endorse') { String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to endorse policy: ' + policyId); ConnectApi.InsurancePolicyIssueOutputRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.endorseInsurancePolicy(policyId); System.debug('Policy endorsed successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while endorsing policy: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute EndorseConnectDriver.callEndorseConnectAPI(); # EndorsePolicy(EndorsePolicyInput, policyId) Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the input JSON. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyOutputRepresentation EndorsePolicy(ConnectApi.EndorsePolicyInputRepresentation EndorsePolicyInput, String policyId) ## Parameters **EndorsePolicyInput** - Type: [ConnectApi.EndorsePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_endorse_policy.htm "Input representation of the request to endorse a policy. Context ID of the quote that’s used for endorsement and date that the endorsed policy version is effective from must be passed in the request.") - Input representation of the request to endorse a policy. **policyId** - Type: String - ID of the policy to be endorsed. ## Return Value Type: [ConnectApi.PolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_policy_output.htm "Output representation of the policy details.") # Error Codes and Responses When using the Insurance APIs, you may encounter error codes and messages under certain conditions. For each family in Insurance, such as Insurance Policy Administration and Quoting, it lists the potential error codes that are related to a specific family and the associated error messages. Error codes are categorized by ranges to indicate their scope and applicability. Each error code follows the format SF-xxxx-yyyy, where: - SF identifies Salesforce error codes. - xxxx specifies the Insurance API family or scope. - yyyy is a unique four-digit identifier for the individual error. Code ranges and their applicability: - SF-0001-xxxx—Common error codes applicable to all Insurance APIs across all Insurance families. - SF-0002-xxxx—Error codes specific to the Insurance Quoting APIs. - SF-0003-xxxx—Error codes specific to the Insurance Policy Administration APIs. The following is a list of error code details for the Insurance APIs. - **[Common Error Codes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_common_error_codes.htm)** Contains the error codes and error code messages that are applicable to all Insurance APIs across all Insurance families. - **[Insurance Policy Administration Error Codes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_admin_error_codes.htm)** Contains the error codes and error code messages that are applicable to the Insurance Policy Administration APIs. - **[Insurance Quoting Errors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_quoting_error_codes.htm)** Contains the error codes and error code messages that are applicable to the Insurance Quoting APIs. # Error Detail Output representation of the error details. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Error code. | Big, 63.0 | 63.0 | | message | String | Message stating the reason for error, if any. | Big, 63.0 | 63.0 | # Error Detail Output representation of the error details. ## JSON Example { "isSuccess": false, "errors": \[ { "errorCode": "RESOURCE\_NOT\_FOUND", "message": "Specify a resource and try again." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Code associated with the error. | Small, 65.0 | 65.0 | | message | String | Message for the error. | Small, 65.0 | 65.0 | # Error Details Output representation for the details of the error code and error message. ## JSON Example { "code": "DATE\_FIELD\_MUST\_BE\_IN\_ISO\_FORMAT", "message": "Specify a date in the yyyy-MM-dd format." } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Error code. | Small, 62.0 | 62.0 | | message | String | Error message. | Small, 62.0 | 62.0 | # Error Response Output representation of the error details. ## JSON Example { "detail": "Looks like you don't have access to this feature. Your Salesforce admin can help with that.", "errors": \[ { "code": "INTERNAL\_ERROR", "message": "Something went wrong. Try again later or contact your Salesforce admin for help." } \], "instance": "", "title": "Access Denied" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | detail | String | Description of the error. | Small, 62.0 | 62.0 | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details_output.htm "Output representation for the details of the error code and error message.")\[\] | Error details for the API process. | Small, 62.0 | 62.0 | | instance | String | Instance where the error occurred. | Small, 62.0 | 62.0 | | title | String | Short label for the error type. | Small, 62.0 | 62.0 | # Evaluation Task Group Input Input representation details of the evaluation task group. ## JSON Example // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are opitional // Fulfillment plan design time entities will be created. "evaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records { "name": "QuoteApproveSuccessTaskGroup", "tasks": \[ // create FulfillmentStepDefinition records { "name": "KYC check flow", // FulfillmentStepDefinition API Names "type": "AutoTask",// FulfillmentStepDefinition type "flowApiName": "KYC check flow", // Flow API Names } \] }, "evaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup { "name": "QuoteApproveFailureTaskGroup", "tasks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | Name of the evaluation task group. | Required | 63.0 | | tasks | [Evaluation Task Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_evaluation_task_input.htm "Input representation details of the evaluation task.")\[\] | List of tasks to be executed for this evaluation task group. | Required | 63.0 | # Evaluation Task Input Input representation details of the evaluation task. ## JSON Example "tasks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] ## Properties
Name Type Description Required or Optional Available Version
flowApiName String API name of the associated flow when the task type is AutoTask.. Required 63.0
name String Name of the evaluation task. Required 63.0
type String Type of the evaluation task. Possible values are:
  • AutoTask
  • Manual
 Required 63.0
# Expected Revenue Output representation of the details of the expected revenue. ## JSON Example This example shows a sample success response. { "policy": { "id": "p111", "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 }, "coverages": \[ { "id": "pc111", "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 }, "ratePlans": \[ { "id": "rp11", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": 100, "type": "FlatPercentOfPremium" } \] }, { "id": "rp12", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "id": "rpc112", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 10000 }, \] } \] } \] } } This example shows a sample error response. { "isSuccess":false, "errors" : \[ { "code":INVALID\_INPUT, "message": "Specify a valid ratePlanId." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 63.0 | 63.0 | | policy | [Expected Revenue Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_exp_rev_policy_output.htm "Output representation of the associated expected revenue details for a policy, such as coverages and rate plans.")\[\] | Map of the policy and expected revenue calculation details. | Small, 63.0 | 63.0 | # Expected Revenue (PATCH) Calculate the expected revenue, derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. The expected revenue amount is rolled up from Insurance Rate Plan to Insurance Coverage and Insurance Policy expected revenue amount. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/expected-revenue ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTSG0000000o9h4AA/expected-revenue?businessSObjectType=InsuranceRatePlan&recordId=1CcSG00000000fx0AA ## Available Version 63.0 ## HTTP Methods PATCH ## Path Parameter for PATCH
Name Type Description Required or Optional Available Version
policyId String

ID of parent policy for which the expected revenue is calculated.

Required 63.0
## Request Parameters for PATCH
Parameter Name Type Description Required or Optional Available Version
businessSObjectType String Name of the business sObject to calculate expected revenue. Possible values are:
  • InsurancePolicy
  • InsurancePolicyCoverage
  • InsuranceRatePlan
Optional 63.0
recordId String ID of the business sObject for which expected revenue must be calculated. Optional 63.0
## Request Body for PATCH ### JSON Example { "expressionSetName": "expressionSetName", "ratePlanCommissions": \[ { "Name": "RPC-1", "Type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "Name": "RPC-1", "Type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 100000 } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | expressionSetName | String | Name of expression set to be used for expected revenue calculation. If unspecified, a value from the InsPolicyManagementConfig setup object is taken. | Optional | 63.0 | | ratePlanCommissions | List | List of rate plan commissions to be used for expected revenue calculation. This is a valid input only when businessSObjectType is InsuranceRatePlan. | Optional | 63.0 | ## Response Body for PATCH [Expected Revenue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_expected_revenue_output.htm "Output representation of the details of the expected revenue.") # Expected Revenue Coverage Output representation details of the coverage and associated expected revenue. ## JSON Example This example shows a sample success response. "coverages": \[ { "id": "pc111", "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 }, "ratePlans": \[ { "id": "rp11", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": 100, "type": "FlatPercentOfPremium" } \] }, { "id": "rp12", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "id": "rpc112", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 10000 }, \] } \] } \] | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | amountWith​Frequency | [Amount With Frequency](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_amount_with_frequency_output.htm "Output representation of the amount details with frequency.")\[\] | Expected revenue amount with frequency. | Small, 63.0 | 63.0 | | id | String | ID of the coverage associated with the policy for which the expected revenue is calculated. | Small, 63.0 | 63.0 | | ratePlans | [Rate Plan](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rate_plan_output.htm "Output representation of the details of the rate plans associated directly with the policy or through coverages.")\[\] | Details of the rate plans associated with the policy or through coverages. | Small, 63.0 | 63.0 | # Expected Revenue Input Input representation of the request to calculate expected brokerage revenue. ## JSON Example { "expressionSetName": "expressionSetName", "ratePlanCommissions": \[ { "Name": "RPC-1", "Type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "Name": "RPC-1", "Type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 100000 } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | expressionSetName | String | Name of expression set to be used for expected revenue calculation. If unspecified, a value from the InsPolicyManagementConfig setup object is taken. | Optional | 63.0 | | ratePlanCommissions | List | List of rate plan commissions to be used for expected revenue calculation. This is a valid input only when businessSObjectType is InsuranceRatePlan. | Optional | 63.0 | # Expected Revenue Policy Output representation of the associated expected revenue details for a policy, such as coverages and rate plans. ## JSON Example This example shows a sample success response. { "policy": { "id": "p111", "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 }, "coverages": \[ { "id": "pc111", "amountWithFrequency": { "annually": 1000.3, "monthly": 100.03, "quarterly": 300.09 }, "ratePlans": \[ { "id": "rp11", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": 100, "type": "FlatPercentOfPremium" } \] }, { "id": "rp12", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "id": "rpc112", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 10000 }, \] } \] } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | amountWithFrequency | [Amount With Frequency](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_amount_with_frequency_output.htm "Output representation of the amount details with frequency.")\[\] | Expected revenue amount with frequency. | Small, 63.0 | 63.0 | | coverages | [Expected Rev Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_exp_rev_coverage_output.htm "Output representation details of the coverage and associated expected revenue.")\[\] | Details of policy coverages, such as associated rate plans. | Small, 63.0 | 63.0 | | id | String | ID of the policy for which expected revenue is calculated. | Small, 63.0 | 63.0 | | ratePlans | [Rate Plan](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rate_plan_output.htm "Output representation of the details of the rate plans associated directly with the policy or through coverages.")\[\] | Details of rate plans. | Small, 63.0 | 63.0 | # Family Policy Details Output representation for individual group policy information. ## JSON Example { "plan": "Gold Plan", "policy": "0YTp00000004C9wAAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | plan | String | Name of the plan that's associated with the policy. | Small, 65.0 | 65.0 | | policy | String | ID of the insurance policy that's created or updated. | Small, 65.0 | 65.0 | # Field Set Field Details Output representation of the field that's associated with a specific field set. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the field in the field set. | Small, 65.0 | 65.0 | | label | String | UI label of the field in the field set. | Small, 65.0 | 65.0 | # Field Set Fields Output representation of the collection of fields that are associated with a specific field set. ## JSON Example This is a sample success response. { "fields": \[ { "apiName": "Field1", "label": "Field 1" } \], "fieldSetId": "0182819gvahBghvdh", "objectName": "ClaimCoveragePaymentDetail" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | [Field Set Field Details\[\]](connect_responses_field_set_field.htm "Output representation of the field that's associated with a specific field set.") | List of fields within the specified field set ID. | Small, 65.0 | 65.0 | | fieldSetId | String | ID of the field set whose associated fields are retrieved. | Small, 65.0 | 65.0 | | objectName | String | API name of the object whose associated fields are retrieved. | Small, 65.0 | 65.0 | # Field Set Fields (GET) Get the fields of a field set by the field set ID and object name. ## Resource {objectName} and {fieldSetId} are placeholders. /connect/fieldset/{objectName}/{fieldSetId}/fields ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/fieldset/ClaimCoveragePaymentDetail/0182819gvahBghvdh/fields ## Available Version 65.0 ## HTTP Methods GET ## Path Parameter for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldSetId | String | ID of the field set to get the associated fields for. | Required | 65.0 | | objectName | String | API name of the object to get the associated fields for. | Required | 65.0 | ## Response Body for GET [Field Set Fields](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_field_set_fields.htm "Output representation of the collection of fields that are associated with a specific field set.") # Financial Management Rate quotes and members, compare census prices, and generate contract transactions. - **[Generate Insurance Contract Transaction Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_insurance_contract_txn.htm)** Asynchronously generate insurance contract transactions (InsuranceContractTrxn and InsuranceContractTrxnDtl records) for the specified contract ID over a given date range. - **[Get Census Price Comparison Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_census_price_comparison.htm)** Calculate price comparison impacts for group census members based on their plan enrollments. This action calculates the financial comparison of changes to a group census by comparing the previous and current costs across plans, group classes, members, and coverages, returning a breakdown of total cost, premium, tax, and fees to help evaluate the comparison of proposed changes. - **[Get Member Ratings and Contributions Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_member_ratings_and_contributions.htm)** Get standard and prorated insurance rates for the specified group census members and their selected plan coverages, including contributions. # Financial Management Rate quotes and members, compare census prices, and generate contract transactions. - **[Generate Insurance Contract Transactions (POST)](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. - **[Group Census Cost Impact before Policy Operation (POST)](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. - **[Insurance Group Rating (POST)](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. - **[Insurance Member Rating (POST)](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. # Find Insurance Policy Action Get the insurance policy associated with a commission statement line item that matches the specified criteria, and update the status of the commission statement line item record. This action is available in API version 63.0 and later. ## Special Access Rules The Find Insurance Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need Insurance Commission Management and Insurance Brokerage User permission sets. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/findInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | commissionStatementLineItemId | String | ID of the commission statement line item record. | | matchingCriteriaPattern | String | String that identifies the corresponding insurance policy. | | failureStatus | String | Indicates the status of the commission statement line item when the item's processing fails. | ## Outputs | Output | Type | Description | | --- | --- | --- | | commissionStatementLineItem | sObject | Commission statement line item record populated with the insurance policy ID. | ## Example **POST** This sample request is for the Find Insurance Policy action. { "inputs": \[ { "commissionStatementLineItemId": "1Atxx0000004DeaCAE", "matchingCriteriaPattern":"InsurancePolicyNumber:PolicyName AND InsurancePolicyEffectiveDate:EffectiveFromDate AND LineOfCoverage:LineOfCoverage AND ClientAccountName:NameInsured.Name" } \] } This is the sample response for the Find Insurance Policy action. { "actionName": "findInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "commissionStatementLineItem": { "attributes": { "type": "CommissionStatementLineItem", "url": "/services/data/v64.0/sobjects/CommissionStatementLineItem/1Atxx0000004C92CAE" }, "InsurancePolicyEffectiveDate": "2025-02-01", "LineOfCoverage": "Medical", "ReferenceRecordId": "0YTxx0000000001GAA", "InsurancePolicyNumber": "test", "Id": "1Atxx0000004C92CAE", "ClientAccountName": "test" } }, "sortOrder": -1, "version": 1 } # Flow for Insurance Brokerage Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Brokerage exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Brokerage include: - computeProducerSplits—Compute the producer splits for the producers associated with an Insurance Policy, for a Commission Statement Line Item. - createProducerCommissions—Create records for the commissions that producers receive for the insurance policy associated with the specified commission statement line item, and update the commission statement line item record status. - findInsurancePolicy—Get the insurance policy associated with a commission statement line item that matches the specified criteria, and update the status of the commission statement line item record. # Flow for Insurance Claims Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Claim exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Claims include: - calculateAdjustments—Calculate the adjusted amount for a loss item and generate data for Insurance Policy Limit Tracking and Claim Coverage Payment Adjustment records. - cancelClaimCvrPaymentDetail—Cancel payment for a claim coverage payment detail record. - createClaim—Create a claim. - createClaimCvrPaymentDetail—Create a claim coverage payment detail record. - createPolicyLimits—Create insurance policy limit records for policy coverage and root attributes. - deleteClaimCvrPaymentDetail—Remove unpaid claim coverage payment details by updating the status of the claim coverage payment detail record to Deleted. - getClaim—Get the details of a claim. - getInsPolicyCurrentStandings—Get the current standings of the insurance policy. - openClaimCoverage—Open a claim coverage. - payClaimCvrPaymentDetail—Initiate the payment for a claim coverage payment detail record, track the policy limit consumption for the payout, and update the status of the claim coverage payment detail record status to Paid upon successful completion. - updateClaim—Update a claim. - updateClaimCoverage—Update a claim coverage. - verifyPolicyCoverage—Verify whether a policy coverage is applicable for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. # Flow for Insurance Group Benefits Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Group Benefits exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Group Benefits include: - applyContractAdjToMemberPolicy—Apply a contract adjustment to a group insurance policy for a primary group census member and a contract group plan. - applyMemberOverrides—Apply member-specific plan, coverage, or attribute overrides on a group insurance quote. - createAcctUsrFrGrpCens—Create person accounts and portal users for group census or group census members. - createContractFromQuote—Create a group insurance contract from a quote. - createCtctUsrFrGrpCens—Create contacts and portal users for group census or group census members. - createQuoteFromInsContract—Create an endorsement or renewal quote from an existing group insurance contract. - endorseContract—Create an endorsed contract version from an existing contract based on the quote for mid-term adjustments. - generateCensus—Asynchronously generate a group census containing member and plan configuration from the active insurance policies associated with an insurance contract. - generateInsuranceContractTrxn—Asynchronously generate insurance contract transactions for the specified contract ID over a given date range. - generateRefreshCensusMembers—Generate or update group census members and their plan configuration details based on policy information from an insurance contract. - getApplicAutoAsgnMbrPlans—Get a combined collection of group census member plans, including the specified plans and plans that are automatically assigned based on contract settings. - getCensusPriceComparison—Get the financial impact of changes to a group census by comparing costs across plans, group classes, members, and coverages. - getGroupCensusMembers—Get the group census member records from the content document in the specified asynchronous bulk request item record. - getGroupCensusMembersAndPlans—Get the group census member records and associated plans from the content document in the specified asynchronous bulk request item record. - getMbrsRatingAndContributions—Get standard and prorated insurance rates for the specified group census members and their selected plan coverages, including contributions. - issueContract—Issue a group insurance contract from a quote. - procMbrPlansForMidTermAdj—Apply mid-term adjustment changes for group insurance policies to group census member plans. - processMemberEnrollment—Process enrolled group census member and their selected plan to create insurance policies and related objects. - refreshCensus—Asynchronously update a group census using the insurance contract data. - renewContract—Renew a group insurance contract by creating a new contract for the next term from a renewal quote. - renewGroupCensusMemberPolicies—Renew group census member policies for contract renewal. - revertMemberOverrides—Revert all overrides for a member under a root quote line item and restore the member details to the default configuration of the group class. - saveGroupCensusMembersData—Create or update the group census member records for primary members, update the IDs of the dependent members, and create or update groups census member records for the dependent members. - saveGrpCensusMbrPlansData—Validate and save group census member plans for the new members, and update the group census member plans for existing members. - validateGroupCensusMembers—Validate the specified group census member records and assign default values to the specified fields. - validateGrpCensusMembersPlans—Validate the specified group census member plan records and assign default values to the specified fields. # Flow for Insurance Policy Administration Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Policy Administration exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Policy Administration include: - cancelInsurancePolicy—Cancel an insurance policy by using a set of user inputs that represent policy details. - createOutOfSeqPlcyEndorsement—Create an out-of-sequence endorsement for an insurance policy. - endorseInsurancePolicy—Endorse an insurance policy by using a set of user inputs that represent policy details. - endorseMultiRootInsPolicy— - getInsurancePolicy—Get the details of an insurance policy. - issueInsurancePolicy— Issue an insurance policy by using a set of user inputs that represent policy details. - issueMultiRootInsPolicy— - reinstateInsurancePolicy—Reinstate a previously canceled insurance policy. - renewInsurancePolicy—Renew an insurance policy by using a set of user inputs that represent policy details. - renewMultiRootInsPolicy— - renewInsurancePolicies—Renew insurance policies in bulk. # Flow for Insurance Product Administration Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Product Administration exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Product Administration include: - invokeUnderwritingRules—Invoke the underwriting rules for different insurance records during the run time. # Flow for Insurance Quoting Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Insurance Quoting exposes additional actionType values for the FlowActionCall Metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values only for Insurance Quoting include: - addEligibleInsuranceClauses—Add eligible insurance clauses to a quote or context. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID along with insurance product clause details. - createInsuranceQuote—Create an Insurance quote by using a context ID or a set of user inputs that represent quote details. - createInsuranceRating—Create a runtime context that contains the details to create a quote. - generateInsuranceClauses—Generate insurance clauses based on the specified quote and context information. You must specify either quote ID or context ID to generate insurance clauses. - getEligibleInsuranceClauses—Get eligible insurance clauses based on quote ID and context ID. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID to get the eligible insurance clauses. - getInsuranceQuoteDetails—Get the details of an insurance quote. - getInsuranceRatingInput—Get the rating input data for the insurance products to support the pricing calculations and coverage analysis. - repriceInsuranceProduct—Recalculate the price of Insurance products based on user inputs. - repriceInsuranceProduct—Recalculate the price of insurance products based on user inputs. - updateInsuranceQuote—Update an existing insurance quote by adding, updating, or deleting nodes and optionally executing pricing and rules. # Generate Census Information from Policies for Contract (POST) 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. ## Resource {contractId} is a placeholder. /connect/insurance/contracts/{contractId}/actions/generate-census ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/generate-census ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the insurance contract whose policies are used to generate the group census. | Required | 68.0 | ## Request Body for POST ### JSON Example { "shouldGenerateCSV": true, "shouldIncludeMemberPlans": true, "filter": { "contractGroupPlanIds": { "values": \[ "0rgVW00000001tlYAA" \] }, "objectName": "Contact", "recordIds": { "values": \[ "003VW00000BcBIfYAN" \] } } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusName | String | Name of the group census to create. | Optional | 68.0 | | censusType | String | Type of group census to generate, such as Enrollment or Quote. | Required | 68.0 | | filter | [Insurance Census Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_filter_input.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that indicate which policy records to include when generating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating the group census, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 | | requestId | String | ID of the asynchronous request from a previous run. | Required when you regenerate a group census that failed in the previous run. | 68.0 | | shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with all the census details (true) or not (false). | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include insurance plan details for each member in the generated group census (true) or not (false). | Optional | 68.0 | ## Response Body for POST [Insurance Generate Census Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_generate_census.htm "Output representation of the details when you generate a group census from the policies on an existing group benefits contract.") # Generate Group Census From Insurance Contract Action Asynchronously generate a group census containing member and plan configuration from the active insurance policies associated with an insurance contract. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/generateCensus Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractId | string | Required. ID of the insurance contract whose details to use to generate group census. | | insGenerateCensusInputRep | Apex-defined | Required. An Apex ConnectApi.InsuranceGenerateCensusInputRepresentation record that contains the policy details to generate the group census. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insGenerateCensusRep | Apex-defined | An Apex ConnectApi.InsuranceGenerateCensusRepresentation record that contains the request ID for the asynchronous process and the ID of the group census record that’s created. | ## Example **POST** This sample request is for the Generate Group Census From Insurance Contract action. { "inputs": \[ { "contractId": "800xx0000004C92AAE", "insGenerateCensusInputRep": { "censusName": "Acme Enrollment Census 2026", "censusType": "Enrollment", "policyEffectiveDate": "2026-01-01", "shouldGenerateCsv": true, "shouldIncludeMemberPlans": true, "filter": { "contractGroupPlanIds": \[ "0gpxx0000000001AAA" \], "objectName": "Contact", "recordIds": \[ "003xx000004WhKhAAK" \] } } } \] } This sample response is for the Generate Group Census From Insurance Contract action. \[ { "actionName": "generateCensus", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insGenerateCensusRep": { "message": "Census generation started successfully", "groupCensusId": "0rfxx0000004C92AAA", "requestId": "08Pxx0000000001EAA" } }, "sortOrder": -1, "version": 1 } \] # Generate Insurance Clauses Action Generate insurance clauses based on the specified quote and context information. You must specify either quote ID or context ID to generate insurance clauses. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/generateInsuranceClauses Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contextId | string | Required if quoteId isn't specified. Context ID of the insurance quote. | | instanceKeys | string | Required if quoteLineItemId isn't specified. Unique keys that identify the products to which quote line items belong. | | optionFlags | Apex-defined | An Apex [runtime\_industries\_insurance.GenerateInsuranceClausesOptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm "HTML (New Window)") record that contains the configuration and execution options to generate the insurance clauses. | | quoteId | string | Required if contextId isn't specified. ID of the insurance quote for adding eligible clauses. | | quoteLineItemIds | string | Required if quoteLineItemId isn't specified. IDs of the quote line item for the quote. | ## Outputs | Output | Type | Description | | --- | --- | --- | | asyncBulkRequestId | string | ID of the asynchronous bulk request. | | errorsList | string | Errors that are encountered during the operation. | | isSuccess | boolean | Indicates whether the operation is successful ( true ) or not ( false ). | ## Example Sample Request { "inputs": \[ { "quoteId": "0Q0xx0000000001AAA", "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "quoteLineItemIds": \[ "0QLxx0000000003CCC" \], "instanceKeys": \[ { "instanceKey": \[ "Auto", "Liability" \] } \], "optionFlags": { "generateClausesAsync": true, "generateManualClauses": false, "saveContext": true } } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for generateInsuranceClauses invocable action public class GenerateInsuranceClausesInvoke { private static final String ACTION\_NAME = 'generateInsuranceClauses'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Either quoteId or contextId is required setInvocationParameter(action, inputs, 'quoteId', false); setInvocationParameter(action, inputs, 'contextId', false); // Optional inputs setInvocationParameter(action, inputs, 'quoteLineItemIds', false); setInvocationParameter(action, inputs, 'instanceKeys', false); // Optional optionFlags map if (inputs != null && inputs.containsKey('optionFlags')) { Map generateClauseOptions = (Map) inputs.get('optionFlags'); if (generateClauseOptions != null) { runtime\_industries\_insurance.GenerateInsuranceClausesOptions apexOptions = new runtime\_industries\_insurance.GenerateInsuranceClausesOptions(); if (generateClauseOptions.containsKey('saveContext')) { apexOptions.SaveContext = (Boolean) generateClauseOptions.get('saveContext'); } if (generateClauseOptions.containsKey('generateManualClauses')) { apexOptions.GenerateManualClauses = (Boolean) generateClauseOptions.get('generateManualClauses'); } if (generateClauseOptions.containsKey('generateClausesAsync')) { apexOptions.generateClausesAsync = (Boolean) generateClauseOptions.get('generateClausesAsync'); } action.setInvocationParameter('optionFlags', apexOptions); } } List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } Sample Response \[ { "actionName": "generateInsuranceClauses", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "isSuccess": true, "asyncBulkRequestId": "750xx0000000001AAA", "errorsList": \[\] }, "sortOrder": -1, "version": 1 } \] # Generate Insurance Contract Transaction Action Asynchronously generate insurance contract transactions (InsuranceContractTrxn and InsuranceContractTrxnDtl records) for the specified contract ID over a given date range. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/generateInsuranceContractTrxn Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractId | string | Required. The ID of the insurance contract to generate transactions for | | insuranceContractGenerateTxnInputRep | Apex-defined | Required. An Apex ConnectApi.InsuranceContractGenerateTrxnInputRepresentation record that contains the date range and an optional name for transaction rollup. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insuranceContractGenerateTxnRep | Apex-defined | An Apex ConnectApi.InsuranceContractGenerateTrxnRepresentation record that contains details about the asynchronous job ID and success status. | ## Example **POST** This sample request is for the Generate Insurance Contract Transaction action. { "inputs": \[ { "contractId": "800xx0000004C92AAE", "insuranceContractGenerateTxnInputRep": { "name": "Q1-2026-Transactions", "fromDate": "2026-01-01", "toDate": "2026-03-31" } } \] } This sample response is for the Generate Insurance Contract Transaction action. \[ { "actionName": "generateInsuranceContractTrxn", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "isSuccess": true, "message": "Transaction generation started successfully", "jobIdentifier": "08Pxx0000000001EAA", "errors": null }, "sortOrder": -1, "version": 1 } \] # Generate Insurance Contract Transactions (POST) 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. ## Resource {contractId} is a placeholder. /connect/insurance/contracts/{contractId}/actions/generate-transactions ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/generate-transactions ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the insurance contract. | Required | 68.0 | ## Request Body for POST ### JSON Example { "name": "Q1-2026-Transactions", "fromDate": "2026-01-01", "toDate": "2026-03-31" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fromDate | String | Start date of the time period for which you want to generate contract transactions, in YYYY-MM-DD format. | Required | 68.0 | | name | String | Name of the transaction generation job. Use a descriptive name so that you can identify the job later. | Optional | 68.0 | | toDate | String | End date of the time period for which to generate contract transactions, in YYYY-MM-DD format. Must be on or after the fromDate. | Required | 68.0 | ## Response Body for POST [Insurance Contract Transactions Generation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_generate_txn_output.htm "Output representation of the details when you start asynchronous generation of contract transactions for a group benefits contract.") # Generate or Update Group Census Members Action Generate or update group census members and their plan configuration details based on policy information from an insurance contract for one or more person accounts or contacts. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/generateRefreshCensusMembers Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractId | string | Required. ID of the insurance contract whose policy data is used to generate or update the group census member information for the associated group census. | | insGenerateRefreshCensusMembersInputRep | Apex-defined | Required. An Apex ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep record that contains the configuration details for generating or updating a group census synchronously. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insGenerateRefreshCensusMembersRep | Apex-defined | An Apex ConnectApi.InsuranceGenerateRefreshCensusMembersRep record that contains the ID of the processed group census record and a list of errors, if any. | ## Example **POST** This sample request is for the Generate or Update Census Members action. { "inputs": \[ { "contractId": "800xx0000004C92AAE", "insGenerateRefreshCensusMembersInputRep": { "censusName": "Acme Enrollment Census 2026", "censusType": "Enrollment", "groupCensusId": "0rfxx0000004C92AAA", "policyEffectiveDate": "2026-01-01", "shouldGenerateCsv": true, "shouldIncludeMemberPlans": true, "personAccountIds": \[ "001xx000003DGb2AAG" \], "contactIds": \[ "003xx000004WhKhAAK" \], "policyIds": \[ "0YTxx0000004C92GAE" \], "additionalFields": { "members": \[ { "memberId": "0YLxx0000004C92EAG", "fields": \[ { "key": "Status\_\_c", "value": "Active" } \] } \] } } } \] } This sample response is for the Generate or Update Census Members action. \[ { "actionName": "generateRefreshCensusMembers", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insGenerateRefreshCensusMembersRep": { "isSuccess": true, "groupCensusId": "0rfxx0000004C92AAA" } }, "sortOrder": -1, "version": 1 } \] # Generate Policy Limits Input Input representation for creating insurance policy limit records. ## JSON Example { "attributeScopes": { "list": \[ "Policy", "PolicyCoverage" \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeScopes | String\[\] | Attribute scopes for which the policy limit records must be created. Valid values are Policy, PolicyCoverage, Claim, ClaimCoverage. | Optional | 65.0 | # Generate Policy Limits Response Output representation for the created insurance policy limit records. ## JSON Example { "policyLimitIds": \[ "0lYx00000004CvQEAU", "0lYx00000004CvREAU" \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | List of errors that are encountered during the processing of the API request. | Small, 65.0 | 65.0 | | policyLimitIds | String\[\] | List of IDs for the insurance policy limit records that are created. | Big, 65.0 | 65.0 | # GenerateInsuranceClausesOptions Class Contains options for generating insurance clauses. Use this class to control context saving, manual clause generation, and asynchronous clause generation when generating product clauses for insurance products. ## Namespace [runtime\_industries\_insurance](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm "The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.") ## Usage Use GenerateInsuranceClausesOptions class when using the [Insurance Product Clause Generation](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clauses_generate.htm) API or the [Generate Insurance Clauses](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_insurance_clauses.htm) invocable action to generate insurance clauses so that you can control context saving and synchronous or asynchronous execution. ## Example When calling the [Generate Insurance Clauses](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_insurance_clauses.htm) invocable action from Apex, create a GenerateInsuranceClausesOptions instance and set the properties, then use it as optionFlags. // Optional optionFlags for generateInsuranceClauses if (inputs != null && inputs.containsKey('optionFlags')) { Map generateClauseOptions = (Map) inputs.get('optionFlags'); if (generateClauseOptions != null) { runtime\_industries\_insurance.GenerateInsuranceClausesOptions generateClauseApexOptions = new runtime\_industries\_insurance.GenerateInsuranceClausesOptions(); if (generateClauseOptions.containsKey('saveContext')) { apexOptions.saveContext = (Boolean) generateClauseOptions.get('saveContext'); } if (generateClauseOptions.containsKey('generateManualClauses')) { apexOptions.generateManualClauses = (Boolean) generateClauseOptions.get('generateManualClauses'); } if (generateClauseOptions.containsKey('generateClausesAsync')) { generateClauseApexOptions.generateClausesAsync = (Boolean) generateClauseOptions.get('generateClausesAsync'); } action.setInvocationParameter('optionFlags', generateClauseApexOptions); } } - **[GenerateInsuranceClausesOptions Constructors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_constructors)** Learn more about the constructors that are available with the GenerateInsuranceClausesOptions class. - **[GenerateInsuranceClausesOptions Properties](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_properties)** Set the properties in the GenerateInsuranceClausesOptions class to generate insurance product clauses. ## GenerateInsuranceClausesOptions Constructors Learn more about the constructors that are available with the GenerateInsuranceClausesOptions class. The GenerateInsuranceClausesOptions class includes these constructors. - **[GenerateInsuranceClausesOptions(saveContext, generateManualClauses, generateClausesAsync)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_ctor)** Creates an options instance with full control over context saving, manual clause generation, and asynchronous execution. - **[GenerateInsuranceClausesOptions(saveContext, generateManualClauses)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_ctor_2)** Creates an options instance for synchronously generating insurance clauses with context and manual clause settings. - **[GenerateInsuranceClausesOptions()](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_ctor_3)** Creates an options instance with the default settings for generating insurance clauses. ### GenerateInsuranceClausesOptions(saveContext, generateManualClauses, generateClausesAsync) Creates an options instance with full control over context saving, manual clause generation, and asynchronous execution. #### Signature public GenerateInsuranceClausesOptions(Boolean saveContext, Boolean generateManualClauses, Boolean generateClausesAsync) #### Parameters **saveContext** - Type: Boolean - Indicates whether to save the operation context (true) or not (false). The default value is true. **generateManualClauses** - Type: Boolean - Indicates whether to generate manual clauses along with automated clauses (true) or not (false). The default value is false. **generateClausesAsync** - Type: Boolean - Indicates whether to generate clauses asynchronously (true) or not (false). The default value is false. ### GenerateInsuranceClausesOptions(saveContext, generateManualClauses) Creates an options instance for synchronously generating insurance clauses with context and manual clause settings. #### Signature public GenerateInsuranceClausesOptions(Boolean saveContext, Boolean generateManualClauses) #### Parameters **saveContext** - Type: Boolean - Indicates whether to save the operation context (true) or not (false). **generateManualClauses** - Type: Boolean - Indicates whether to generate manual clauses along with automated clauses (true) or not (false). ### GenerateInsuranceClausesOptions() Creates an options instance with the default settings for generating insurance clauses. #### Signature public GenerateInsuranceClausesOptions() ## GenerateInsuranceClausesOptions Properties Set the properties in the GenerateInsuranceClausesOptions class to generate insurance product clauses. The GenerateInsuranceClausesOptions class includes these properties. - **[generateClausesAsync](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_generateClausesAsync)** Indicates whether clauses are generated asynchronously (true) or synchronously (false). - **[generateManualClauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_generateManualClauses)** Indicates whether to generate manual clauses along with system-generated clauses (true) or not (false). - **[saveContext](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_runtime_industries_insurance_GenerateInsuranceClausesOptions_saveContext)** Indicates whether to save the operation context (true) or not (false). ### generateClausesAsync Indicates whether clauses are generated asynchronously (true) or synchronously (false). #### Signature public Boolean generateClausesAsync {get; set;} #### Property Value Type: Boolean ### generateManualClauses Indicates whether to generate manual clauses along with system-generated clauses (true) or not (false). #### Signature public Boolean generateManualClauses {get; set;} #### Property Value Type: Boolean ### saveContext Indicates whether to save the operation context (true) or not (false). #### Signature public Boolean saveContext {get; set;} #### Property Value Type: Boolean # Get Applicable Auto-Assigned Member Plans Action Get a combined collection of group census member plans, including the specified plans and plans that are automatically assigned based on contract settings. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getApplicAutoAsgnMbrPlans Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | censusMemberPlanData | Apex-defined | An Apex ind\_ins\_grpben\_\_GroupCensusMemberNode record that contains census member plan records, such as group census members, member plans, and plan attributes. | | groupCensusMemberPlans | List | Collection of group census member plan records. | | groupCensusMembers | List | Collection of group census member records that are used to determine plan applicability. | ## Outputs | Output | Type | Description | | --- | --- | --- | | censusMemberPlanData | Apex-defined | An Apex ind\_ins\_grpben\_\_GroupCensusMemberNode record that contains a collection of census member plan records, such as group census members, member plans, and plan attributes. | | errorsData | Apex-defined | An Apex ind\_ins\_grpben\_\_ErrorDetails record that contains a collection of error records that occurred during the retrieval of group census member and plans records. | | groupCensusMemberPlans | List | Collection of group census member plan records. | | groupCensusMembers | List | Collection of group census member records that are used to determine plan applicability. | ## Example **POST** This sample request is for the Get Applicable Member Plans action. { "inputs": \[ { "censusMemberPlanData": \[ { "member": { "FirstName": "Test\_Primary", "AssociationWithPrimaryMbr": "Self", "OverrideTypeConfiguration": "Default", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "GroupClassId": "a1AXXXXXXXXXXXXAAA" }, "plans": \[\] }, { "member": { "FirstName": "Test\_Spouse", "AssociationWithPrimaryMbr": "Spouse", "OverrideTypeConfiguration": "Default", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "GroupClassId": "a1AXXXXXXXXXXXXAAA" }, "plans": \[\] } \] } \] } This sample response is for the Get Applicable Member Plans action. \[ { "actionName": "getApplicAutoAsgnMbrPlans", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "censusMemberPlanData": \[ { "member": { "FirstName": "Test\_Primary", "AssociationWithPrimaryMbr": "Self", "OverrideTypeConfiguration": "Default", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "GroupClassId": "a1AXXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001", "planOperation": "Add" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001", "planOperation": "Add" }, "attributes": \[\] } \] }, { "member": { "FirstName": "Test\_Spouse", "AssociationWithPrimaryMbr": "Spouse", "OverrideTypeConfiguration": "Default", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "GroupClassId": "a1AXXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001", "planOperation": "Add" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001", "planOperation": "Add" }, "attributes": \[\] } \] } \], "errorsData": \[\] }, "sortOrder": -1, "version": 1 } \] # Get Census Price Comparison Action Calculate price comparison impacts for group census members based on their plan enrollments. This action calculates the financial comparison of changes to a group census by comparing the previous and current costs across plans, group classes, members, and coverages, returning a breakdown of total cost, premium, tax, and fees to help evaluate the comparison of proposed changes. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getCensusPriceComparison Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | censusId | string | Required. ID of the group census record to calculate price comparisons for. | | insurancePriceComparisonInput | Apex-defined | An Apex ConnectApi.InsurancePriceComparisonInputRepresentation record that contains the optional filters, such as member IDs, category, and fetch attribute flag to calculate price comparisons. | ## Outputs | Output | Type | Description | | --- | --- | --- | | priceComparisonOutput | Apex-defined | An Apex ConnectApi.RateComparisonOutputRepresentation record that contains the hierarchical price comparison results. | ## Example **POST** This sample request is for the Get Census Price Comparison action. { "inputs": \[ { "censusId": "0rfxx000000001aEAA", "insurancePriceComparisonInput": { "category": "0ZGIO0000000gAX4AY", "fetchAttributes": false, "memberIds": { "values": \[ "0rgxx000000001aEAA", "0rgxx000000002bEAA" \] } } } \] } This sample response is for the Get Census Price Comparison action. \[ { "actionName": "getCensusPriceComparison", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "priceComparisonOutput": { "categories": { "dental": "Dental", "vision": "Vision" }, "comparisons": \[ { "category": null, "current": { "attributes": \[\], "fee": 400, "id": "0rHxx000000001aEAA", "premium": 2000, "tax": 180, "total": 2580 }, "durationKey": "dur1", "id": "identifier1", "name": null, "node": "summary", "parent": null, "previous": { "attributes": \[\], "fee": 200, "id": "0rHxx000000002bEAA", "premium": 1800, "tax": 180, "total": 2180 } } \], "currencyInfo": { "locale": "en\_US", "name": "USD", "symbol": "$" }, "durations": \[ { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } \], "errors": \[\], "isSuccess": true, "summary": { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } } }, "sortOrder": -1, "version": 1 } \] # Get Claim Action Get the details of a claim. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getClaim Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | getClaimInputRepresentation | Apex-defined | Required. An Apex [ConnectApi.GetClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_get_claim.htm "Input representation to get the details of a claim.") record that contains the details of the claim to be retrieved. | ## Outputs | Output | Type | Description | | --- | --- | --- | | getClaimOutputRepresentation | Apex-defined | An Apex [ConnectApi.GetClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_claim_output.htm "Output representation for the Get Claim action.") record that contains the details of the claim that's retrieved. | | claimItemOutputs | Apex-defined | A collection of Apex [ConnectApi.ClaimItemOutputs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_item_outputs.htm "Invocable action output representation for a wrapper that contains a list of claim items.") records that contain the list of claim items. | | claimParticipantOutputs | Apex-defined | A collection of Apex [ConnectApi.ClaimParticipantOutputs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_participant_outputs.htm "Invocable action output representation for a wrapper that contains a list of claim participants.") records that contain the list of claim participants. | ## Example Sample Request { "inputs": \[ { "getClaimInputRepresentation": { "claimId": "0Z1S70000004oVfIAI" } } \] } Sample Response \[ { "actionName": "getClaim", "errors": null, "isSuccess": true, "outputValues": { "getClaimOutputRepresentation": { "claimDetails": { "accountId": "001xx000003DGQyAAO", "attributes": \[ { "apiName": "PoliceReportNumber", "value": "SF-2025-09-13-00123" } \], "claimReason": "Auto accident", "claimReasonType": "AUTO\_ACCIDENT", "claimType": "AUTO\_ACCIDENT", "lossType": "Front bumper damaged" }, "claimId": "0Z1S70000004oVfIAI", "contextId": "C-000123", "expenseReserveAmount": 750.50, "insurancePolicyId": "0e9S70000004oVfIAI", "lossDate": "2025-07-22", "lossReserveAmount": 5000.00, "name": "Claim for Auto Accident", "productCode": "AUTO-ACCIDENT" }, "claimItemOutputs": \[ { "claimItems": \[ { "category": "Auto Physical Damage", "claimDetails": { "accountId": "001xx000003DGQyAAO", "attributes": \[ { "apiName": "DamageSeverity", "value": "Severe" } \], "claimReason": "Auto accident", "claimReasonType": "AUTO\_ACCIDENT", "claimType": "AUTO\_ACCIDENT", "lossType": "Front bumper damaged" }, "id": "0koxx000000001dEAA", "instanceKey": "item\_vehicle\_bumper\_01", "name": "Damaged Front Bumper", "productCode": "AUTO-BUMPER-SEDAN", "insuredItemId": "02ixx0000004l5sAAA" } \] } \], "claimParticipantOutputs": \[ { "claimParticipants": \[ { "id": "0kaxx000000001dEAA", "instanceKey": "participant\_driver\_1", "accountId": "001xx000003DGQyAAO", "contactId": "003xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "roles": \[ "Driver", "Claimant" \] } \] } \], "sortOrder": -1, "version": 1 } } \] # Get Eligible Insurance Clauses Action Get eligible insurance clauses based on quote ID and context ID. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID to get the eligible insurance clauses. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getEligibleInsuranceClauses Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contextId | string | Required if quoteId isn't specified. Context ID of the insurance quote. | | instanceKey | string | Required if quoteLineItemId isn't specified. Unique key that identifies the product to which a quote line item belongs. | | quoteId | string | Required if contextId isn't specified. ID of the insurance quote to get eligible clauses. | | quoteLineItemId | string | Required if instanceKey isn't specified. ID of the quote line items to get eligible clauses. | ## Outputs | Output | Type | Description | | --- | --- | --- | | eligibleClauses | string | Details of insurance product clauses. | | errorsList | string | Errors that are encountered during the operation. | | isSuccess | boolean | Indicates whether the operation is successful ( true ) or not ( false ). | ## Example Sample Request { "inputs": \[ { "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "instanceKey": \[ "a3Nxx000000CmikEAC" \], "quoteId": "0Q0xx000000Dm3jCAC", "quoteLineItemId": "0QLxx000000E5d1OAC" } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for getEligibleInsuranceClauses invocable action public class GetEligibleInsuranceClausesInvoke { private static final String ACTION\_NAME = 'getEligibleInsuranceClauses'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Either quoteId or contextId is required setInvocationParameter(action, inputs, 'quoteId', false); setInvocationParameter(action, inputs, 'contextId', false); // Either quoteLineItemId or instanceKey is required setInvocationParameter(action, inputs, 'quoteLineItemId', false); setInvocationParameter(action, inputs, 'instanceKey', false); List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } Sample Response \[ { "actionName": "getEligibleInsuranceClauses", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "getEligibleClausesOutputRep": { "errors": \[\], "insuranceProductClauses": \[ { "category": "Manual", "clauseName": "mxtestIC", "description": "two variable", "effectiveDate": "2025-10-01", "expirationDate": "2025-12-31", "insuranceProductClauseId": "...", "type": "Clause" } \], "success": true } }, "sortOrder": -1, "version": 1 } \] # Get Group Census Members Action Get the group census member records from the content document in the specified asynchronous bulk request item record. The action processes bulk member data that are uploaded through census management workflows, validates the data, identifies duplicate records, and returns structured member records for saving or further processing. It returns all transformed member records along with detailed error information for any records that fail validation. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getGroupCensusMembers Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
asyncBulkRequestItem sobject Required. Asynchronous bulk request item record that contains the metadata of the CSV file. This property must include the AdditionalInformation field with serialized JSON that contains these details.
  • contentDocumentId—ID of the content document
  • contentDocumentVersion—Version number of the content document
  • csvColumnMapping—Mapping of CSV columns to target field names
  • duplicateDetectionFields—List of fields that are used to detect duplicates
  • groupCensusId—ID of the parent group census
  • csvHeader—Header row from the CSV file
  • startRowNumber—First CSV row to process
  • endRowNumber—Last CSV row to process
  • duplicateRowNumbersList—List of row numbers identified as duplicates
## Outputs | Output | Type | Description | | --- | --- | --- | | duplicateDetectionKeysList | string | Comma-separated list of group census member fields that are used to identify unique group census member records. It's shown if duplicate detection fields are configured in the request. | | errorsData | Apex-defined | Errors for the records that failed validation or parsing. Each error includes the row number, error code, error message, and field-level details. | | groupCensusId | string | ID of the group census record that's associated with the group census member records that the action returned. | | groupCensusMembers | sobject | Group census member records that the action returns. Each record contains mapped field values from CSV columns. Records with errors include an error field with the error message. Maximum number of records that are returned is 2000. | ## Example **POST** This sample request is for the Get Group Census Members action. { "inputs": \[ { "AdditionalInformation": "{employeeBulkRequestInfo:{groupCensusId:0rfSG0000000vclYAA,contentDocumentName:Archit50Records With groupClass - Archit50Records With groupClass (1),contentDocumentId:069SG000004lwPdYAI,contentDocumentVersion:068SG000004PIp3YAG,duplicateDetectionFields:\[Gender,FirstName,Lastname,AssociationWithPrimaryMbr,GroupCensusId\],batchSize:null,csvColumnMapping:{First Name:FirstName,Last Name:Lastname,Gender:Gender,Birthdate:Birthdate,SmokerStatus:SmokerStatus,Relationship:AssociationWithPrimaryMbr,Group Class:GroupClassName},executeRules:false},startRowNumber:1,endRowNumber:27,startByteOffset:83,endByteOffset:1717,csvHeader:First Name,Last Name,Gender,Birthdate,Relationship,SmokerStatus,Group Class,Errors,duplicateRowNumbersList:\[\],shouldExecuteConfigurationRule:false}", "Id": "18cSG0000003DgfYAE" } \] } This sample response is for the Get Group Census Members action. \[ { "actionName": "getGroupCensusMembers", "errors": null, "isSuccess": true, "outputValues": { "duplicateDetectionKeysList": \[\], "groupCensusId": "0rfSG0000000zY9YAI", "groupCensusMembers": \[ { "Email": "ross.farley\_0001@insgroup.co.in", "AssociationWithPrimaryMbr": "Self", "FirstName": "Ross", "Lastname": "Farley", "Country": "Health Comprehensive|Chronic Disease", "Gender": "Male", "Birthdate": "08/07/1981" }, { "Email": "teagan.wallace\_0001@gmail.com", "AssociationWithPrimaryMbr": "Spouse", "FirstName": "Teagan", "Lastname": "Wallace", "Country": "Health Comprehensive|Critical Illness & Surgery", "Gender": "Female", "Birthdate": "08/07/1986" } \] } } \] # Get Group Census Members and Plans Action Get the group census member records and associated plans from the content document in the specified asynchronous bulk request item record. The action processes bulk member data that are uploaded through census management workflows. This action validates the data, identifies duplicates, and returns structured member records for further processing. This action returns all transformed records, along with detailed error information for any records that fail validation. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getGroupCensusMembersAndPlans Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
asyncBulkRequestItem sobject Required. Asynchronous bulk request item record that contains the metadata about the CSV upload. This property must have the AdditionalInformation field with serialized JSON that contains these details.
  • contentDocumentId—ID of content document
  • contentDocumentVersion—Version of content document
  • csvColumnMapping—Map of CSV column to field name
  • duplicateDetectionFields—List of fields for duplicate detection
  • groupCensusId—Parent Group Census ID
  • csvHeader—CSV header row
  • startRowNumber—Starting row to process
  • endRowNumber—Ending row to process
  • duplicateRowNumbersList—Pre-identified duplicate rows
## Outputs | Output | Type | Description | | --- | --- | --- | | duplicateDetectionKeysList | string | Comma-separated list of group census member fields that can be used to identify unique group census member records. This property is returned if duplicate detection fields are configured in the request. | | errorsData | Apex-defined | Error records that occurred during the retrieval of group census member and plan records. | | groupCensusId | string | Salesforce ID of the GroupCensus record which these members belong to. This property is used to associate members with their parent census. | | groupCensusMembers | sobject | Collection of transformed GroupCensusMember SObject records that are parsed from the CSV file. Each record includes field values that are mapped from the corresponding CSV columns. Records with errors include an error field containing the error message. The maximum limit size is 2000. | | groupCensusMemberPlans | sobject | Collection of plan records for group census members. | | shouldExecuteConfigurationRule | boolean | Indicates whether the product configuration rules must be executed for member plans in the enrollment census ( true ) or not ( false ). | ## Example Sample Request { "AdditionalInformation": { "employeeBulkRequestInfo": { "groupCensusId": "0rfSG0000000vclYAA", "contentDocumentName": "Archit50Records With groupClass - Archit50Records With groupClass (1)", "contentDocumentId": "069SG000004lwPdYAI", "contentDocumentVersion": "068SG000004PIp3YAG", "duplicateDetectionFields": \[ "Gender", "FirstName", "Lastname", "AssociationWithPrimaryMbr", "GroupCensusId" \], "batchSize": null, "csvColumnMapping": { "First Name": "FirstName", "Last Name": "Lastname", "Gender": "Gender", "Birthdate": "Birthdate", "SmokerStatus": "SmokerStatus", "Relationship": "AssociationWithPrimaryMbr", "Group Class": "GroupClassName" }, "executeRules": false }, "startRowNumber": 1, "endRowNumber": 27, "startByteOffset": 83, "endByteOffset": 1717, "csvHeader": "First Name,Last Name,Gender,Birthdate,Relationship,SmokerStatus,Group Class,Errors", "duplicateRowNumbersList": \[\], "shouldExecuteConfigurationRule": false }, "Id": "18cSG0000003DgfYAE" } Sample Response \[ { "actionName": "getGroupCensusMembersAndPlans", "errors": null, "isSuccess": true, "outputValues": \[ { "GroupClassName": "Test\_MGR", "AssociationWithPrimaryMbr": "Self", "FirstName": "Employee1", "Lastname": "Salesforce1", "Gender": "Male", "Birthdate": "1987-12-04", "SmokerStatus": "Tobacco" }, { "AssociationWithPrimaryMbr": "Spouse", "FirstName": "Employee2", "Lastname": "Salesforce2", "Gender": "Female", "Birthdate": "1982-11-30", "SmokerStatus": "Tobacco" }, { "AssociationWithPrimaryMbr": "Child", "FirstName": "Employee3", "Lastname": "Salesforce3", "Gender": "Male", "Birthdate": "1988-11-18", "SmokerStatus": "NonTobacco" } \] } \] # Get Insurance Policy Action Get the details of an insurance policy. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Details
insurancePolicyId Type

String

Description

ID of the insurance policy to be retrieved.
## Outputs
Output Details
contextId Type

String

Description

Context ID of the retrieved insurance policy.
## Example Sample Request { "inputs": \[ { "policyId": "0YTxx00000001H3GAI" } \] } Sample Response \[ { "actionName": "getInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "contextId": "0000000i18tq18g00291753332964253e35d47202c0c428785435cdfa2f44ae8" }, "sortOrder": -1, "version": 1 } \] # Get Insurance Policy Current Standings Action Get the current standings of the insurance policy. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getInsPolicyCurrentStandings Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | getInsPlcyCurrStndInputRep | Apex-defined | Required. An Apex [ConnectApi.GetInsPlcyCurrStndInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_get_ins_plcy_curr_stnd_input_re.htm "An Apex ConnectApi.GetInsPlcyLmtCurrStndInputRep record that contains the details needed to retrieve the consumed and available limits for the policy or claim.") record that contains the details to retrieve the consumed and available limits for the policy or claim. | ## Outputs | Output | Type | Description | | --- | --- | --- | | getInsPlcyCurrStndOutputRep | Apex-defined | An Apex [ConnectApi.GetInsPlcyCurrStndOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_ins_plcy_curr_stnd_output_re.htm "An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy or claim.") record that contains the details of the consumed and available limits that are retrieved for the policy claim. | ## Example Sample Request { "inputs": \[ { "getInsPlcyCurrStndInputRep": { "policyId": "01t000000000000001", "claimId": null, "policyParticipantId": null, "policyAssetId": null, "policyCoverageId": null, "claimCoverageId": null, "options": { "viewOption": "showAllPolicyCoverages", "shouldIncludePendingAmount": true } } } \] } Sample Response \[ { "actionName": "getInsPolicyCurrentStandings", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "getInsPlcyCurrStndOutputRep": \[ { "iplStandingCalcOutputNodes": \[ { "amounts": { "initialAmount": 500, "pendingAmount": 25, "predictedRemainingAmount": 325, "remainingAmount": 350, "totalUsedAmount": 150 }, "coverageInfo": { "claimCoverageId": "1TDSG0000007HU84AM", "claimId": "0cYSG000000UYlq2AG", "policyAssetId": "0cYSG000000UYzt2XY", "policyCoverageId": "0cYSG000000UYlq2AG", "policyParticipantId": "sdfbdsf976sff", "subCoverageName": "auto-parts" }, "limitAttributes": { "applicableAction": \[ "PaymentAttempted" \], "durationType": "PolicyTerm", "category": "LimitCurrency", "policyLimitStandingKey": "PolicyCover LimitCurrency" }, "mappedScopes": { "parentMappedScopeId": "a0MS70000004oVfIAI", "prodtAttrMappedScopeId": "a0MS70000004oVgIAI" }, "values": { "initialValue": 10000, "pendingValue": 500, "predictedRemainingValue": 8000, "remainingValue": 8500, "totalUsedValue": 1500 } } \] } \] }, "sortOrder": -1, "version": 1 } \] # Get Insurance Quote Details Action Get the details of an insurance quote. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getInsuranceQuoteDetails Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | quoteId | String | Required. ID of the insurance quote to get the details for. | | filters | String | Optional. The filters used to filter the insurance quote or line items associated with the insurance quote. | ## Outputs
Output Details
contextId Type

String

Description

Context ID of the insurance quote that's created.
contextJson Type

Map<String, Object>

Description

List of insurance context details.
## Example Sample Request { "inputs": \[ { "quoteId": "0Q0xx0000004CXECA2" } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for getInsuranceQuoteDetails invocable action public class GetInsuranceQuoteDetailsInvoke { private static final String ACTION\_NAME = 'getInsuranceQuoteDetails'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Optional inputs setInvocationParameter(action, inputs, 'quoteId', false); setInvocationParameter(action, inputs, 'filters', false); List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } Sample Response \[ { "actionName": "getInsuranceQuoteDetails", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "contextId": "0000000i18tq18g00291753491555889e8ef669a59f0453fade5acbe4595a3d6", "contextJson": { "SalesTransaction": \[ { "Status": "Draft", "Account": null, "BillingCity": null, "Subtotal": 1350, "businessObjectType": "Quote", "SalesTransactionName": "Multi Auto", "TotalAmount": 1350, "ShippingStreet": null, "SalesTransactionItem": \[ { "ProrationPolicy": "0muxx000000004sAAA", "ProductName": "Medical Payments", "ProductCode": "STA-3", "ProductSellingModel": "0jPxx000000004sEAA", "SpecificationType": "Coverage", "TaxTreatment": "1ttxx000000004rAAA", "SalesTransactionItemParent": "0Q0xx0000004CE1CAM", "Quantity": 1, "Product": "01txx0000006i7KAAQ", "businessObjectType": "QuoteLineItem", "PricebookEntry": "01uxx0000008ybrAAA", "PricingTermCount": 1, "StartDate": "2023-10-19T00:00:00Z", "NetUnitPrice": 750, "UnitPrice": 750, "id": "0QLxx0000004CIpGAM" }, { "ProrationPolicy": null, "ProductName": "Collision", "ProductCode": "STA-2", "ProductSellingModel": "0jPxx000000004tEAA", "SpecificationType": "Coverage", "TaxTreatment": "1ttxx000000004rAAA", "SalesTransactionItemParent": "0Q0xx0000004CE1CAM", "Quantity": 1, "Product": "01txx0000006i7JAAQ", "businessObjectType": "QuoteLineItem", "PricebookEntry": "01uxx0000008ybsAAA", "PricingTermCount": 1, "StartDate": null, "NetUnitPrice": 500, "UnitPrice": 500, "id": "0QLxx0000004CIqGAM" } \], "BillingCountry": null, "BillingStreet": null, "Pricebook": "01sxx0000005pyfAAA", "Opportunity": null, "ShippingPostalCode": null, "SalesTransactionSource": "0Q0xx0000004CE1CAM", "ShippingCountry": null, "ShippingCity": null, "ShippingState": null, "BillingPostalCode": null, "id": "0Q0xx0000004CE1CAM", "Contract": null, "BillingState": null } \] } }, "sortOrder": -1, "version": 1 } \] # Get Insurance Rating Input Action Get the rating input data for the insurance products to support the pricing calculations and coverage analysis. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getInsuranceRatingInput Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | additionalFields | string | JSON string of additional fields to include in the rating context. | | effectiveDate | date | Effective date for the rating calculation. | | productIds | string | Required. IDs of the products to generate the rating input for. | | ratingDate | date | Date to use for rating calculations. | | rootProductCodes | string | List of root product codes. | | salesTransactionTypeId | string | ID of the sales transaction type. | | transactionType | string | Name of the transaction type. | ## Outputs | Output | Type | Description | | --- | --- | --- | | getRatingInputOutputRep | Apex-defined | An Apex ConnectApi\_\_GetRatingInputOutputRep record that contains the details of the rating input for insurance products. | ## Example **POST** This sample request is for the Get Insurance Rating Input action. { "inputs": \[ { "additionalFields": { "QuoteAccount": "001ZM000002ZNnBYAW" }, "effectiveDate": "2024-01-01", "productIds": \[ "01tRM0000000001" \], "ratingDate": "2024-01-01", "rootProductCodes": \[ "ProductCode1" \], "salesTransactionTypeId": "0k5RM0000000001", "transactionType": "NewBusiness" } \] } This is a sample request to call this invocable action from Apex code. // Sample implementation to call insurance get rating input invocable action in Apex public class InsuranceGetRatingInputApexService implements Callable { private static final String GET\_RATING\_INPUT\_METHOD = 'getRatingInput'; /\*\* \* @description Implementation of Callable interface for OmniStudio \* @param action Method name to invoke \* @param args Map containing input, output, and options \* @return Object result of the method invocation \*/ public Object call(String action, Map args) { System.debug('InsuranceGetRatingInputApexService: call ' + action); Map input = (Map) args.get('input'); Map output = (Map) args.get('output'); Map options = (Map) args.get('options'); return invokeMethod(action, input, output, options); } // Invoke methods, and if the method is not supported, it will be ignored. public Boolean invokeMethod( String methodName, Map inputs, Map output, Map options ) { Boolean response = false; System.debug('Insurance Get Rating Input Apex Service - Method: ' + methodName); try { if (GET\_RATING\_INPUT\_METHOD.equals(methodName)) { response = getRatingInput(inputs, output, options); } else { throw new UnsupportedOperationException('this method name is incorrect or not supported'); } } catch (Exception e) { response = false; output.put('success', false); output.put('errorMessage', 'Exception occurred: ' + e.getMessage()); System.debug(LoggingLevel.ERROR, 'Exception in invokeMethod: ' + methodName + ', Error: ' + e.getMessage()); System.debug(LoggingLevel.ERROR, 'Stack trace: ' + e.getStackTraceString()); } System.debug('Output from invoke:' + output); return response; } private Boolean getRatingInput(Map inputs, Map output, Map options) { Map getRatingInputPayload = inputs; // Handle null input if (getRatingInputPayload == null) { output.put('success', false); output.put('errorMessage', 'ratingInput is required in the payload for rating'); output.put('errorType', 'VALIDATION\_ERROR'); return false; } System.debug('Create Rating Input: ' + JSON.serialize(getRatingInputPayload)); try { System.debug('Calling Invocable Action: getInsuranceRatingInput'); // Create and configure the invocable action Invocable.Action action = Invocable.Action.createStandardAction('getInsuranceRatingInput'); // productIds is required setInvocationParameter(action, getRatingInputPayload, 'productIds', true); // salesTransactionTypeId is optional setInvocationParameter(action, getRatingInputPayload, 'salesTransactionTypeId', false); // transactionType is optional setInvocationParameter(action, getRatingInputPayload, 'transactionType', false); // effectiveDate is optional setInvocationParameter(action, getRatingInputPayload, 'effectiveDate', false); // ratingDate is optional setInvocationParameter(action, getRatingInputPayload, 'ratingDate', false); // rootProductCodes is optional setInvocationParameter(action, getRatingInputPayload, 'rootProductCodes', true); // additionalFields is optional, but to be serialized setInvocationParameter(action, getRatingInputPayload, 'additionalFields', true); // Execute the action List results = action.invoke(); if (results != null && !results.isEmpty()) { Invocable.Action.Result result = results\[0\]; System.debug('IA result: ' + JSON.serialize(result)); if (result.isSuccess()) { System.debug('Get Rating Input created successfully from Invocable Action'); output.put('output', result.getOutputParameters()); // Extract key information from the result Map outputParams = result.getOutputParameters(); if (outputParams != null) { if (outputParams.containsKey('getRatingInputOutputRep')) { output.put('getRatingInputOutputRep', outputParams.get('getRatingInputOutputRep')); } System.debug('Rating Input data extracted: ' + outputParams); } List actionErrors = result.getErrors(); if (actionErrors != null && !actionErrors.isEmpty()) { output.put('success', false); output.put('error', result.getErrors()); return false; } output.put('success', true); return true; } else { // Action failed - get error details List actionErrors = result.getErrors(); String errorMessage = 'Get Rating Input Invocable Action failed'; if (actionErrors != null && !actionErrors.isEmpty()) { List errorMessages = new List(); List> errorDetailsList = new List>(); for (Invocable.Action.Error actionError : actionErrors) { errorMessages.add(actionError.getMessage()); errorDetailsList.add(new Map{ 'message' => actionError.getMessage(), 'code' => actionError.getCode() }); } errorMessage = String.join(errorMessages, '; '); output.put('actionErrors', errorDetailsList); } output.put('success', false); output.put('errorMessage', errorMessage); System.debug(LoggingLevel.ERROR, 'Get Rating Input Invocable Action failed: ' + errorMessage); return false; } } else { output.put('success', false); output.put('errorMessage', 'Get Rating Input Invocable Action returned null or empty results'); System.debug(LoggingLevel.WARN, 'Get Rating Input Invocable Action returned null/empty results'); } return false; } catch (Exception e) { output.put('success', false); output.put('error', e.getMessage()); return false; } } private void setInvocationParameter(Invocable.Action action, Map quotePayload, String inputAttribute, boolean serializeJSON) { if (quotePayload.containsKey(inputAttribute) && quotePayload.get(inputAttribute) != null) { System.debug('InsuranceGetRatingInputApexService::' + inputAttribute + ': ' + JSON.serialize(quotePayload.get(inputAttribute))); if (serializeJSON) { action.setInvocationParameter(inputAttribute, JSON.serialize(quotePayload.get(inputAttribute))); } else { action.setInvocationParameter(inputAttribute, quotePayload.get(inputAttribute)); } } else { System.debug('Payload does not contain attribute: ' + inputAttribute); } } } This sample response is for the Get Insurance Rating Input action. \[ { "actionName": "getInsuranceRatingInput", "errors": null, "invocationId": null, "isSuccess": true, "outputValues": { "isSuccess": true, "getRatingInputOutputRep": { "ratingInputs": \[ { "additionalFields": {}, "attributes": {}, "instanceKeys": \[ "Key1" \], "productCode": "ProductCode1" } \], "success": true, "message": "successful" }, "errorsList": \[\] }, "sortOrder": -1, "version": 1 } \] # Get Member Ratings and Contributions Action Get standard and prorated insurance rates for the specified group census members and their selected plan coverages, including contributions. This action retrieves member-specific coverage selections, validates them against the root plan hierarchy, and invokes the rating service to calculate premiums and contributions. The action returns pricing results with rates at member, plan, and coverage levels, along with hierarchical error information. The action is currently used in enrollment flows. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getMbrsRatingAndContributions Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | groupCensusMembers | sobject | Required. Collection of group census member records for whom rates must be calculated. This action retrieves the member IDs from these records. The maximum list size is 2000. | | contractGroupPlanId | string | Required. ID of the root contract group plan for which the rates and contributions must be calculated. This ID represents the primary plan under which coverages are organized. The action validates that selected coverages that belong to this plan hierarchy. | | effectiveDate | date | Effective date for rating calculations in yyyy-MM-dd format. If specified, the rating service uses this date to lookup the active pricing procedure and perform proration calculations. If not specified, contract start date is used as default. | ## Outputs | Output | Type | Description | | --- | --- | --- | | memberRatingOutputRep | Apex-defined | An Apex ind\_ins\_grpben\_\_MembersPlansRatingOutput record that contains pricing results for the requested members, plans, and coverages. The Apex class includes standard rates, prorated rates, contributions, and hierarchical error information at the request, member, plan, and coverage levels. | ## Example Sample Request { "inputs": \[ { "groupCensusMembers": \[ { "Id": "0r6SG0000008OFjYAM", "Name": "John Doe", "FirstName": "John", "LastName": "Doe", "Email": "john.doe@example.com", "BirthDate": "1985-03-15" }, { "Id": "0r6SG0000008OFjYAN", "Name": "Jane Smith", "FirstName": "Jane", "LastName": "Smith", "Email": "jane.smith@example.com", "BirthDate": "1990-07-22" } \], "contractGroupPlanId": "0rgSG0000000ef1YAA", "effectiveDate": "2025-10-15" } \] } Sample Response \[ { "actionName": "getMbrsRatingAndContributions", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "memberRatingOutputRep": { "pricingResults": \[ { "plans": \[ { "rates": \[ { "value": 60, "key": "NetUnitPrice" } \], "proratedRates": \[ { "value": 60, "key": "NetUnitPrice" } \], "planId": "0rgSG0000000eezYAA", "errors": \[\], "coverages": \[ { "rates": \[ { "value": 20, "key": "NetUnitPrice" } \], "proratedRates": \[ { "value": 20, "key": "NetUnitPrice" } \], "errors": \[\], "coverageId": "0rgSG0000000ef1YAA", "contributions": { "groupClassContributionId": "0rFSG0000000Beb2AE", "errors": \[\], "employerPremiumAmount": 2, "employeePremiumAmount": 18 } } \], "contributions": { "groupClassContributionId": null, "errors": \[\], "employerPremiumAmount": 2, "employeePremiumAmount": 58 } } \], "memberId": "0r6SG0000008R33YAE", "errors": \[\] } \], "errors": \[\] } }, "sortOrder": -1, "version": 1 } \] # Get Policy Output representation of policy details. ## JSON Example This example shows a sample response when you pass a policy ID in the get policy request. { “insurancepolicy” : { “id” : “xxxxxxxXxx”, “policyName” : “policyName”, “policyNumber” : “PN-10012”, “universalPolicyNumber” : “TNS-123981”, “effectiveFromDate” : “2023/01/01”, //ISO format - yyyy-mm-dd “effectiveToDate” : “2023/12/31”, .. .. “insurancePolicyCoverages” : \[ { “coverageName” : “Collision”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. }, { “coverageName” : “Theft Protection”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. } \] “insurancePolicyAssets” : \[ { “assetName” : “Audi A3”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. “insurancePolicyCoverages” : \[ { “coverageName” : “Collision”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. }, { “coverageName” : “Theft Protection”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. } \] }, { “assetName” : “Audi A4”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. “insurancePolicyCoverages” : \[ { “coverageName” : “Collision”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. }, { “coverageName” : “Theft Protection”, “effectiveFromDate” : “2023/01/01”, “effectiveToDate” : “2023/12/31”, .. .. } \] } \] } } This example shows a sample response when you pass the contextOnly query parameter as true in the request. When the contextOnly parameter is true, the API returns a context ID along with the insurance policy details. { "contexId": "e02036acf464f323f197c200895fec48a6a62ae3c711b3603609f08817c4af48 ", "insurancePolicy": {} } This example shows a sample response when expand\[attributes\] query parameter is set to true. { "insurancePolicy": { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", "originalEffectiveFromDate": "2024-01-01", "originalEffectiveToDate": "2024-12-31", "active": true, .... .... "grossWrittenPremium": 1678.28, "insurancePolicyAssets": \[ { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", "assetName": "Auto Bundle", "id": "0YWSG0000000N4f4AE", .... .... "insurancePolicyAssets": \[\], "insurancePolicyParticipants": \[ { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", "id": "0aoSG000000sNvhYAE", .... .... "insurancePolicyAssets": \[\], "insurancePolicyCoverages": \[\], "insurancePolicyParticipants": \[\], "insurancePolicyParticipantAttributes": \[ { "id": "19USG0000004r382AA", "attributeDefinitionId": "0tjSG00000049D8YAI", "attributeName": "DriverAccidents", "attributeValue": "2.0", "insurancePolicyParticipantId": "0aoSG000000sNvhYAE" } \], "additionalFields": {} } \], "insurancePolicyCoverages": \[ { "coverageName": "Comprehensive", "id": "0cYSG0000005gt32AA", "insurancePolicyAssetId": "0YWSG0000000N4f4AE", "insurancePolicyId": "0YTSG000000233R4AQ", "name": "IPC-00000034", .... .... "insurancePolicyCoverageAttributes": \[ { "id": "19VSG0000004r2w2AA", "attributeDefinitionId": "0tjSG00000049DjYAI", "attributeName": "LimitBI", "attributeValue": "100", "insurancePolicyCoverageId": "0cYSG0000005gt32AA" }, .... .... { "id": "19VSG0000004r342AA", "attributeDefinitionId": "0tjSG00000049DXYAY", "attributeName": "RentalNumDays", "attributeValue": "10", "insurancePolicyCoverageId": "0cYSG0000005gt32AA" } \], "additionalFields": {} } \], "insurancePolicyAssetAttributes": \[ { "id": "19QSG0000004r2X2AQ", "attributeDefinitionId": "0tjSG00000049E4YAI", "attributeName": "Body Type", "attributeValue": "NA", "insurancePolicyAssetId": "0YWSG0000000N4f4AE" }, .... .... { "id": "19QSG0000004r2Y2AQ", "attributeDefinitionId": "0tjSG00000049DIYAY", "attributeName": "Alternative Fuel", "attributeValue": "NA", "insurancePolicyAssetId": "0YWSG0000000N4f4AE" } \], "additionalFields": {} } \], "additionalFields": {} } } This example shows a sample response for the get policy request with additional fields. The request returns a list of field-set IDs when the operator is $in and a single field-set ID when the operator is $eq. // GET /connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]=0IXSG000001ADt34AG,0IXSG000001AUqf4AG,0IXSG000001AUp34AG,0IXSG000001AUsH4AW { "insurancePolicy": { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", .... .... "insurancePolicyAssets": \[ { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", "assetName": "Auto Bundle", "id": "0YWSG0000000N4f4AE", "assetCode": "BMW", .... "insurancePolicyAssets": \[\], "insurancePolicyParticipants": \[ { "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-09-29", "id": "0aoSG000000sNvhYAE", "insurancePolicyId": "0YTSG000000233R4AQ", "name": "IPP-00000032", .... .... "insurancePolicyParticipantAttributes": \[\], "additionalFields": { "InsurancePolicyId": "0YTSG000000233R4AQ", "EffectiveFromDate": "2024-01-01", "Id": "0aoSG000000sNvhYAE" }, } \], "insurancePolicyCoverages": \[ { "coverageName": "Comprehensive", "id": "0cYSG0000005gt32AA", "insurancePolicyAssetId": "0YWSG0000000N4f4AE", .... }, "insurancePolicyCoverageAttributes": \[\], "additionalFields": { "CoverageName": "Comprehensive", "Id": "0cYSG0000005gt32AA" } } \], "insurancePolicyAssetAttributes": \[\], "additionalFields": { "Name": "IPA-00000035" } } \], "additionalFields": { "CheckboxField\_\_c": true, "EffectiveFromDate": "2024-01-01", "Name": "Admin User Policy001" } } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context. | Small, 63.0 | 63.0 | | error | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | insurancePolicy | Map | Details of insurance policy. | Small, 63.0 | 63.0 | # Get Quote Output representation of the details of the get quote details. ## JSON Example This example shows a sample response when you pass a quote ID in the get quote details request. { "contextId": "fa917d24acfaa40c14943d7009f096b2952c974a6e940d1302c465cd3abaee3d", "errors": \[\], "insuranceContext": { "SalesTransaction": \[ { "Status": "Draft", "Account": null, "BillingCity": null, "Subtotal": 1350, "businessObjectType": "Quote", "SalesTransactionName": "Multi Auto", "TotalAmount": 1350, "ShippingStreet": null, "SalesTransactionItem": \[ { "ProrationPolicy": "0muxx000000004sAAA", "ProductName": "Medical Payments", "ProductCode": "STA-3", "ProductSellingModel": "0jPxx000000004sEAA", "SpecificationType": "Coverage", "TaxTreatment": "1ttxx000000004rAAA", "SalesTransactionItemParent": "0Q0xx0000004CE1CAM", "Quantity": 1, "Product": "01txx0000006i7KAAQ", "businessObjectType": "QuoteLineItem", "PricebookEntry": "01uxx0000008ybrAAA", "PricingTermCount": 1, "StartDate": "2023-10-19T00:00:00Z", "NetUnitPrice": 750, "UnitPrice": 750, "id": "0QLxx0000004CIpGAM" }, { "ProrationPolicy": null, "ProductName": "Collision", "ProductCode": "STA-2", "ProductSellingModel": "0jPxx000000004tEAA", "SpecificationType": "Coverage", "TaxTreatment": "1ttxx000000004rAAA", "SalesTransactionItemParent": "0Q0xx0000004CE1CAM", "Quantity": 1, "Product": "01txx0000006i7JAAQ", "businessObjectType": "QuoteLineItem", "PricebookEntry": "01uxx0000008ybsAAA", "PricingTermCount": 1, "StartDate": null, "NetUnitPrice": 500, "UnitPrice": 500, "id": "0QLxx0000004CIqGAM" } \], "BillingCountry": null, "BillingStreet": null, "Pricebook": "01sxx0000005pyfAAA", "Opportunity": null, "ShippingPostalCode": null, "SalesTransactionSource": "0Q0xx0000004CE1CAM", "ShippingCountry": null, "ShippingCity": null, "ShippingState": null, "BillingPostalCode": null, "id": "0Q0xx0000004CE1CAM", "Contract": null, "BillingState": null } \] } } This example shows a sample response when you pass the filter and non-filter request parameters. //GET /connect/insurance/quotes/0Q0xx0000004CIiCAM?contextId=0000000i18tq18g002917545349255616564529f415d45c4b1b1ea08747a2195&filter\[ProductSpec\]\[eq\]=InsuredItem&filter\[DYN\_\_Auto\_Value\]\[gt\]=60000&returnChildrenNodes=true&includeClause=true { "contextId": "0000000i18tq18g002917545349255616564529f415d45c4b1b1ea08747a2195", "errors": \[\], "insuranceContext": { "SalesTransaction": \[ { "Status": "Draft", "Account": null, "BillingCity": null, "Subtotal": 1350, "businessObjectType": "Quote", "SalesTransactionName": "Multi Auto", "TotalAmount": 1350, "ShippingStreet": null, "SalesTransactionItem": \[ { "businessObjectType": "QuoteLineItem", "Product": "01txx0000006i3EAAQ", "DYN\_\_License\_State": null, "ValidationResult": null, "DYN\_\_AssetRecordName": "02ixx0000004HI3AAM", "PolicyPremium": null, "SalesTransactionSourceAsset": null, "PeriodBoundaryStartMonth": null, "ProratedQLITaxAmount": 0, "id": "0QLxx0000004CozGAE", "STICurrencyIsoCode\_\_std": null, "IntermediateVariableOne": null, "ProductCode": "auto", "SalesTrxnItemRelatedObject": \[ { "RelatedObject": "02ixx0000004HI3AAM", "ParentReference": "0QLxx0000004CozGAE", "RelatedObjectName": "Asset", "QuoteLineItem": "0QLxx0000004CozGAE", "businessObjectType": "QuoteLineItemRelatedObject", "id": "1A2xx0000004CNZCA2", "UsageType": "ExtendedAttribute" } \], "SalesTransactionItemInsClause\_\_std": \[ { "SalesTranxItemInsClauseConstraintModelName\_\_std": "Q2Blitz\_V1", "ParentReference": "0QLSB000000b8Q34AI", "SalesTranxItemInsClauseName\_\_std": "FreeLookPeriodClause", "businessObjectType": "QuoteLineItemInsProductClause", "SalesTranxItemInsClauseText\_\_std": "On Collision, Auto Added, only eligible when collision deductible is 100. Deductible is 100.", "InsuranceProductClause\_\_std": "1T8SB00000000Xt0AI", "id": "9TeSB000004Ny7d0AC", "SalesTranxItemInsClauseEffectiveDate\_\_std": "2025-08-01", "SalesTranxItemInsClauseExpirationDate\_\_std": "2025-08-31", "SalesTranxItemInsClauseCreationMethod\_\_std": "AutoAdded", "SalesTranxItemInsClauseParent\_\_std": "0QLSB000000b8Q34AI", "SalesTranxItemInsClauseDescription\_\_std": null } \], "Subtotal": 320, "LineItemPath": "0QLxx0000004Cp1GAE/0QLxx0000004CozGAE", "PricebookEntry": "01uxx0000008yXWAAY", "DiscountAmount": null, "NetUnitPrice": 320, "DYN\_\_Is\_Electric\_Vehicle": false, "ParentReference": "0Q0xx0000004CIiCAM", "DYN\_\_Model": "A3", "EndQuantity": 1, "NetTotalPrice": 320, "TotalLineAmount": 320, "UnitPrice": 320, "DYN\_\_Auto\_Value": 100000, "SalesTrxnItemRelationship": \[ { "ParentReference": "0QLxx0000004CozGAE", "AssociatedItem": "0QLxx0000004CozGAE", "MainItemRole": "Bundle", "ProductRelatedComponent": "0dSxx000000001EEAQ", "businessObjectType": "QuoteLineRelationship", "AssociatedItemPricing": "IncludedInBundlePrice", "ProductRelationshipType": "0yoxx0000000001AAA", "RootItemProductCode": "autoSilver", "IsPriceInclusive": true, "RootItem": "0QLxx0000004Cp1GAE", "RootItemProductSellingModel": "0jPxx0000000001EAA", "MainItem": "0QLxx0000004Cp1GAE", "AssociatedQuantScaleMethod": "Proportional", "id": "0yQxx00000000RSEAY", "AssociatedItemRole": "BundleComponent", "SalesTrnItemRelationshipParent": "0Q0xx0000004CIiCAM", "MainItemProduct": "01txx0000006i3DAAQ", "MainItemProductSellingModel": "0jPxx0000000001EAA", "RootItemProduct": "01txx0000006i3DAAQ" } \], "ProductSpec": "InsuredItem", "SalesTransactionItemAttribute": \[ { "AttributeValue": null, "ParentReference": "0QLxx0000004CozGAE", "hasObjectRef": null, "businessObjectType": "QuoteLineItemAttribute", "AttributeDefinitionCode": "LicenseNumber", "SalesTransactionItemAttrParent": "0QLxx0000004CozGAE", "AttributeDeveloperName": "License\_Number", "AttributeKey": "0tjxx0000000013AAA", "AttributePicklistValue": null, "IsPriceImpacting": null, "AttributeName": "License Number", "id": "0zuxx00000001vWAAQ" } \], "BillingCountry": null, "StandardTaxAmount": 0, "BillingStreet": null, "PriceAdjustmentSchedule": null, "SalesTransactionSource": "0Q0xx0000004CIiCAM", "TotalStandardAmount": 640, "EffectiveDate": null } \], "DeletedSTIIds": \[\] } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the insurance context. | Small, 63.0 | 63.0 | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | insuranceContext | Map | List of insurance context details. | Small, 63.0 | 63.0 | # Get Rating Input (POST) Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API (/connect/insurance/product-rating) after replacing sample values with real data. Use this resource at design time to generate a sample rating input payload for a root insurance product. Provide a Product2 ID. The API traverses the product hierarchy, including bundles, components, and attributes, builds a fully populated sample request body suitable for /connect/insurance/product-rating, and returns it as a JSON string in ratingInput. The generated payload includes product codes, instance keys, and attribute codes with sample values. Parse the ratingInput string, replace sample values with real data, and then submit the result to the product-rating API. Review additionalDetails for guidance about fields the sample may omit, such as transactionType. When generation succeeds, ratingInput contains the sample payload and errors is empty or absent. When generation fails, errors lists the failures. Examples include: - SF-INS-DSAV-00013 — a product ID is required. Specify a valid product ID. Returned with HTTP status 400 when productId is missing. - SF-INS-DSAV-00014 — the specified product ID doesn’t exist or isn’t accessible. Returned with HTTP status 400. Insufficient access, or Design Advisor not enabled for the org, returns HTTP status 403. An unexpected failure returns HTTP status 500. ## Resource /connect/insurance/design-advisor/get-rating-input ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/get-rating-input ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productId": "01txx0000006iPnAAI" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the product for which you want to generate a sample rating API request. Must be a valid 15- or 18-character Salesforce ID. | Required | 68.0 | ## Response Body for POST [Insurance Get Rating Input Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_get_rating_input.htm "Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails.") # Get Started with Insurance Developer Resources Use the developer resources of Insurance Cloud to manage end-to-end insurance processes. Create and configure quotes, manage policy transactions, and automate processes related to brokerage policies and commissions.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
Learn more about the developer resources that are available for these components. ## Insurance Brokerage Manage insurance policy lifecycles. Automate processes related to Policy and Commissions Management. See [Insurance Brokerage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_overview.htm "Use the Insurance Brokerages developer resources to automate processes related to Policy and Commissions Management. Invoke policy lifecycle services such as Renew, Repurpose, and Cancel using context service. Manage plan benefits using a flexible service layer and Product Catalog."). ## Insurance Claims Management Manage insurance claims by automating, streamlining, and orchestrating the full lifecycle of a claim, from coverage validation to final settlement. See [Insurance Claims Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_overview.htm "Use the Insurance Claims developer resources to set up claim products and create dynamic first notice of loss intake flows for your users. Give claim adjusters a cohesive view of claims and financial data so they can efficiently assess and settle claims. Establish financial controls and automatically route requests for financial approval to the appropriate supervisors and managers."). ## Insurance Design Advisor Check your product configuration against everything a quote or policy flow needs. The advisor validates selling models, pricebook entries, pricing procedures, attributes, user permissions, and context definitions, and returns structured validation results with step-by-step remediation guidance. See [Insurance Design Advisor](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor.htm "Use Insurance Design Advisor to check your product configuration against everything a quote or policy flow needs. The advisor validates selling models, pricebook entries, pricing procedures, attributes, user permissions, context definitions, and more, and then returns structured validation results with step-by-step remediation guidance. Ask in natural language through Agentforce or use your desired MCP client. Validations run independently and you see every issue in a single pass, rather than discovering them one at a time."). ## Insurance Group Benefits Manage insurance group benefit plans that re offered to and covering a group of people, such as employees and their dependents. See [Insurance Group Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_overview.htm "Group benefits are insurance plans offered to and covering a group of people, such as employees and their dependents. Manage these insurance offerings in a rapidly evolving marketplace with Group Benefits on the Digital Insurance Platform."). ## Insurance Policy Administration Manage policy lifecycles across quoting, issuance, endorsements, billing, and renewals. See [Insurance Policy Administration](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_overview.htm "Use the Insurance Policy developer resources to manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation. Each transaction type creates an InsurancePolicyTransaction record."). ## Insurance Product Administration Define the products you sell to customers, including their classifications, categories, and attributes. Create customized price adjustment methods and pricing procedures. Define rules that determine how your products behave when they're quoted, sold, and serviced. See [Insurance Product Administration](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_overview.htm "Use the Insurance Product Administration developer resources to define the products you sell to customers, including their classifications, categories, and attributes. Create customized price adjustment methods and pricing procedures. Define rules that determine how your products behave when they're quoted, sold, and serviced."). ## Insurance Quoting Automate quoting experiences as part of a cohesive customer-centric experience. Create, update, configure, and delete quotes and quote line items. See [Insurance Quoting](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_overview.htm "Use the Insurance Quoting developer resources to create, update, configure, and delete quotes and quote line items."). # GetClaim(claimId) Get the details of a specific claim. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.ClaimOutputRepresentation GetClaim(String claimId) ## Parameters **claimId** - Type: String - ID of the claim to retrieve the details for. ## Return Value Type: [ConnectApi.ClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_output.htm "Output representation for a retrieved claim.") ## Example Use this Apex example to retrieve claim details from the Claim Management system by using the Get Claim API. The example shows how to invoke the Connect API method ConnectApi.ClaimFamily.GetClaim() and handle responses and errors in Apex. **Class Definition** Here's an example that shows how to invoke the Get Claim API by using Apex. // Output the claim data to the debug log System.debug('Claim Data: ' + JSON.serializePretty(claimData));g action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'getClaim') { // Retrieve the claim ID from the input map String claimId = (String) inputMap.get('claimId'); System.debug('Start of connect API call to get claim with ID: ' + claimId); // Initialize the claim output representation ConnectApi.ClaimOutputRepresentation claimData; // Call the Connect API to get the claim try { claimData = ConnectApi.ClaimFamily.getClaim(claimId); System.debug('Claim retrieved successfully: ' + claimData); // Put the claim data in the output map outputMap.put('claimData', claimData); } catch (Exception e) { System.debug('Error while retrieving claim: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the claim data return claimData; } // If the action is not recognized, return null return null; } } **Usage Example** You can use the GetClaimCallable class in Apex to call the getClaim action and retrieve claim details by the claim ID. GetClaimCallable callable = new GetClaimCallable(); // Prepare the input arguments Map input = new Map(); // Get claimId from user input (you can modify this to get from different sources) // Option 1: From URL parameters (if called from a Visualforce page or Lightning component) String claimId = ApexPages.currentPage().getParameters().get('claimId'); if (String.isBlank(claimId)) { System.debug('Please provide a claimId. You can set it in the input map.'); } // Add the claimId to the input map input.put('claimId', claimId); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'getClaim' action Object result = callable.call('getClaim', args); // Retrieve the claim data from the result ConnectApi.ClaimOutputRepresentation claimData = (ConnectApi.ClaimOutputRepresentation) result; // Output the claim data to the debug log System.debug('Claim Data: ' + JSON.serializePretty(claimData)); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # getCommissionProcessing(commissionProcessingInput) Process commission statements in an asynchronous manner by using the preconfigured batch job. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceCommissionProcessingOutputRepresentation getCommissionProcessing(ConnectApi.InsuranceCommissionProcessingInputRepresentation commissionProcessingInput) ## Parameters **commissionProcessingInput** - Type: [ConnectApi.InsuranceCommissionProcessingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_commission_processing.htm "Input representation details of the insurance commission processing resource. The input includes the commissionStatementIds property required to process commission data.") - Input representation details of the insurance commission processing API. ## Return Value Type: [ConnectApi.InsuranceCommissionProcessingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_commission_processing_output.htm "Output representation details of the commission processing resource.") ## Usage Commission Statement Processing API uses a JSON input that contains a list of commissionStatementIds. The service processes the commission statement asynchronously by using a batch job. The batch job calls the processing flow to process each commission statement line item. When the processing is complete, the service updates the commission statement and sends a notification to the user. # getInsuranceMemberEligiblePlans(memberId, shouldIncludeDependents) Get the enrollment plans for which a group census member and their dependents are eligible. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGetMembersPlans getInsuranceMemberEligiblePlans(String memberId, Boolean shouldIncludeDependents) ## Parameters **memberId** - Type: String - ID of the group census member. **shouldIncludeDependents** - Type: Boolean - Indicates whether to include eligible plans for the member's dependents in the response (true) or not (false). ## Return Value Type: [ConnectApi.InsuranceGetMembersPlans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_get_members_plans.htm "Output representation for a member's eligible plans.") ## Example Here's an example of how to invoke the Insurance Get Member Eligible Plans API from Apex code. // Get Member Eligible Plans via Connect API (simple version) // Replace with an existing Group Census Member Id String memberId = '0r6xx00000007BrAAI'; // Optional: include dependents’ plans (requires API version >= 258) Boolean includeDependents = true; try { ConnectApi.InsuranceGetMembersPlans result = ConnectApi.InsuranceGroupBenefitsFamily.getInsuranceMemberEligiblePlans(memberId, includeDependents); System.debug('Eligible Plans response: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error while fetching eligible plans: ' + e.getMessage()); } # GetPolicy(policyId, connectDynamicParameters) Get details of an insurance policy. Pass additional context or metadata to customize the information that's fetched. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.GetPolicyOutputRepresentation GetPolicy(String policyId, Map connectDynamicParameters) ## Parameters **policyId** - Type: String - ID of the policy for which the details are to be fetched. **connectDynamicParameters** - Type: [Map](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_map.htm "HTML (New Window)") - Map of connect dynamic parameters to fetch the policy details. ## Return Value Type: [ConnectApi.GetPolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_get_policy_output.htm "Output representation of the policy details.") ## Usage Use this API to fetch the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information. - When the contextOnly parameter is true, the API returns a context ID along with the insurance policy details. - When you send a request with additional fields with the operator $in, it returns a list of field-set IDs. When the operator is $eq, the request returns a single field-set ID. For examples, see [Get Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_policy_output.htm). # getRatingInput(insGetRatingInputInputRepresentation) Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API after replacing sample values with real data. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsGetRatingInputRepresentation getRatingInput(ConnectApi.InsGetRatingInputInputRepresentation insGetRatingInputInputRepresentation) ## Parameters insGetRatingInputInputRepresentation Type: [ConnectApi.InsGet​Rating​Input​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_get_rating_input.htm "Input representation that specifies the product for which to generate a sample rating input payload.") Required. Input that identifies the root Product2 record for which to generate a sample rating input payload. ## Return Value Type: [ConnectApi.InsGet​Rating​Input​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_get_rating_input.htm "Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails.") ## Usage Use this method at design time to generate a sample rating input payload for a root insurance product. Provide a Product2 ID. The method traverses the product hierarchy, including bundles, components, and attributes, builds a fully populated sample request body suitable for the Insurance Product Rating API, and returns it as a JSON string in ratingInput. The generated payload includes product codes, instance keys, and attribute codes with sample values. Parse the ratingInput string, replace sample values with real data, and then submit the result to the product-rating API. Review additionalDetails for guidance about fields the sample may omit, such as transactionType. When generation succeeds, ratingInput contains the sample payload and errors is empty or null. When generation fails, errors lists the failures. Examples include: - SF-INS-DSAV-00013 — a product ID is required. Specify a valid product ID. - SF-INS-DSAV-00014 — the specified product ID doesn’t exist or isn’t accessible. ## Example This sample generates a rating input payload from Apex. ConnectApi.InsGetRatingInputInputRepresentation input = new ConnectApi.InsGetRatingInputInputRepresentation(); input.productId = '01txx0000006i3DAAQ'; ConnectApi.InsGetRatingInputRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.getRatingInput(input); System.debug('ratingInput=' + result.ratingInput); System.debug('additionalDetails=' + result.additionalDetails); System.debug('errors=' + result.errors); # Group Census Cost Impact before Policy Operation (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. 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/price-comparisons ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/price-comparisons ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census to compare the prices for. | Required | 68.0 | ## Request Body for POST ### JSON Example { "category": "0ZGIO0000000gAX4AY", "fetchAttributes": false, "memberIds": { "values": \[ "0r6IO0000004F25AE" \] } } ### Properties
Name Type Description Required or Optional Available Version
category String ID of the product category to filter the comparison. If not specified, the API returns only the overall summary and the list of available categories. Optional 68.0
fetchAttributes Boolean Indicates whether to return the attributes of the root products and coverages, such as copay and coinsurance (true) or not (false). The default value is false.

If set to true, the API returns plan attribute differences instead of price comparison details.

 Optional 68.0
memberIds String[] List of group census member IDs to compare prices for. If not specified, the API returns the summary view of the census instead of member-level comparisons. Optional 68.0
## Response Body for POST [Price Comparison Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_output.htm "Output representation of the price impact that's calculated for a group census. The response includes the available product categories, the event summary, the rating periods, the currency, and a flat list of comparison items that carry the previous and current amounts for each plan, group class, member, and coverage.") # Group Census Deep Clone Input Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition. ## JSON Example { "contextDefId": "Custom\_GroupCensus\_DeepClone", "groupCensusFilters": { "memberPlanFilter": { "quoteId": "0Q0xx0000004CtoCAE" } }, "groupCensusReferenceMappings": { "memberPlanReferenceMapping": { "contractId": "800xx0000004C92AAE" } }, "targetGroupCensusOverrides": { "Name": "Acme Enrollment Census", "Description": "Enrollment census cloned from the quoting census" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextDefId | String | API name of the custom context definition that overrides the standard group census deep-clone context definition. Use this property when you need unique fields or specialized mappings that the standard context definition doesn't include. | Optional | 68.0 | | groupCensusFilters | [Group Census Filters Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_filters_input.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that limit which records in the source census hierarchy are cloned. For example, clone only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [Group Census Reference Mappings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_reference_mappings_input.htm "Input representation of the per-entity reference values saved to group census member plan records.") | Reference mappings to apply on the cloned records. Use these mappings to associate source references with target references, such as mapping quote line items to contract group plans. | Optional | 68.0 | | targetGroupCensusOverrides | Object | Map of field API names and values to apply to the cloned group census. Use this map to set new values on the target census, such as the census name or description. | Optional | 68.0 | # Group Census Deep Clone Response Output representation of the details that are returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. ## JSON Example This is a sample success response. { "errors": \[\], "requestId": "15USB000007EXbB2AW" } This is a sample response with errors. { "errors": \[ { "code": "SF-INS-GB-00102", "message": "The source Group Census record 0rfSB0000004aCvYAI doesn't exist or isn't accessible." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while validating the request or scheduling the asynchronous deep-clone job. An empty list indicates that the job is processed successfully. | Big, 68.0 | 68.0 | | requestId | String | ID of the asynchronous deep-clone request. Use this ID to track the status and results of the job. | Big, 68.0 | 68.0 | # Group Census Field Mapping Input Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records. ## JSON Example { "groupCensusFilters": { "memberPlanFilter": { "quoteId": "0Q0xx0000004CtoCAE" } }, "groupCensusReferenceMappings": { "memberPlanReferenceMapping": { "contractId": "800xx0000004C92AAE" } } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusFilters | [Group Census Filters Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_filters_input.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that identify which records of the existing group census are processed. For example, process only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [Group Census Reference Mappings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_reference_mappings_input.htm "Input representation of the per-entity reference values saved to group census member plan records.") | Reference mapping rules that update group census records from a quote to a contract or from a contract to a quote. For example, remap quote line item references to contract group plans after a quote is converted to a contract. | Optional | 68.0 | # Group Census Field Mapping Response Output representation of the details that are returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. ## JSON Example This is a sample success response. { "errors": \[\], "requestId": "15USB000007EXbB2AW" } This is a sample response with errors. { "errors": \[ { "code": "SF-INS-GB-00102", "message": "The source Group Census record 0rfSB0000004aCvYAI doesn't exist or isn't accessible." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while validating the request or scheduling the asynchronous field-mapping job. An empty list indicates that the job was scheduled successfully. | Big, 68.0 | 68.0 | | requestId | String | ID of the asynchronous bulk request. Use this ID to track the status and results of the field-mapping job. | Big, 68.0 | 68.0 | # Group Census Filters Input Input representation of the per-entity filters that scope which group census member plan records are processed. ## JSON Example { "memberPlanFilter": { "quoteId": "0Q0xx0000004CtoCAE" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberPlanFilter | [Member Plan Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_filter_input.htm "Input representation of the filter that identifies which group census member plan records to process.") | Filter that identifies the group census member plan records to process for a specific group benefits quote or contract. | Optional | 68.0 | # Group Census Group Class Summary Output representation of census summary data aggregated by group class. ## JSON Example { "groupCensus": { "id": "a0B1x000000XXXXX", "memberOptOutCount": 5, "mbrWithoutDependentCount": 20, "memberWithOneChildCount": 15, "mbrWithMoreThan1ChldCount": 10, "mbrWithMoreThan2ChldCount": 5, "memberWithDependentCount": 30, "memberWithSpouseCount": 25, "totalMemberPlusDependent": 85, "totalDependents": 45, "totalMembers": 40, "fullTimeMemberCount": 35, "partTimeMemberCount": 5, "grpCensusGrpClassSummaryList": \[ { "id": "a0C1x000000YYYYY", "groupCensusId": "a0B1x000000XXXXX", "groupClassId": "a0D1x000000ZZZZZ", "memberOptOutCount": 2, "mbrWithoutDependentCount": 10, "memberWithOneChildCount": 5, "mbrWithMoreThan1ChldCount": 3, "mbrWithMoreThan2ChldCount": 2, "memberWithDependentCount": 10, "memberWithSpouseCount": 8, "totalMemberPlusDependent": 28, "totalDependents": 15, "totalMembers": 13, "fullTimeMemberCount": 12, "partTimeMemberCount": 1 } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fullTime​MemberCount | Integer | Total number of full-time members for this group class. | Small, 65.0 | 65.0 | | groupCensusId | String | ID of the group census. | Small, 65.0 | 65.0 | | groupClassId | String | ID of the group class. | Small, 65.0 | 65.0 | | id | String | ID of the group census group class summary record. | Small, 65.0 | 65.0 | | mbrWithMore​Than1Chld​Count | Integer | Total number of members who have more than one child dependent for this group class. | Small, 65.0 | 65.0 | | mbrWithMore​Than2ChldCount | Integer | Total number of members who have more than two child dependents for this group class. | Small, 65.0 | 65.0 | | mbrWithout​DependentCount | Integer | Total number of members who have no dependents for this group class. | Small, 65.0 | 65.0 | | memberOptOut​Count | Integer | Total number of members who have actively opted out of all insurance plans for this group class. | Small, 65.0 | 65.0 | | memberWith​DependentCount | Integer | Total number of members who have at least one dependent of any type, such as spouse or children for this group class. | Small, 65.0 | 65.0 | | memberWith​OneChildCount | Integer | Total number of members who have exactly one child dependent for this group class. | Small, 65.0 | 65.0 | | memberWith​SpouseCount | Integer | Total number of members who have a spouse listed as a dependent for this group class. | Small, 65.0 | 65.0 | | partTime​MemberCount | Integer | Total number of part-time members for this group class. | Small, 65.0 | 65.0 | | totalDependents | Integer | Total number of dependents for this group class. | Small, 65.0 | 65.0 | | totalMember​PlusDependent | Integer | Total of all members and all their dependents for this group class. | Small, 65.0 | 65.0 | | totalMembers | Integer | Total number of members for this group class. | Small, 65.0 | 65.0 | # Group Census Member Input Input representation for the details of the group census member. ## JSON Example { "members": \[ { "accountId": "0015j00000AbCdEfGHI", "additionalFields": \[ { "key": "EmployeeNumber\_\_c", "value": "E12345" } \], "annualEligibleSalary": 82000.5, "associationWithPrimaryMbr": null, "birthdate": "1990-08-25", "city": "Austin", "contactId": "0035j00000KlMnOpQR", "country": "USA", "dependentCount": 0, "email": "alex.taylor@example.com", "firstName": "Alex", "fullTimeEquivalent": 1, "gender": "Non-Binary", "groupCensusId": "0r65j00000StUvWxYZ", "groupClassId": "a015j00000XyZ12aBC", "groupClassName": "Full-Time Salaried", "grpCensusGrpClassSummaryId": "a025j00000GhIjKkLM", "id": "0r65j00000StUvWxYZ", "isOptOutAllPlans": false, "isPortalUser": false, "joinDate": "2023-03-15", "lastname": "Taylor", "memberKey": "TAYLOR-ALEX-19900825", "memberType": "Primary", "name": "Alex Taylor", "optOutPlanTypes": null, "phoneNumber": "512-555-0199", "policyStartDate": "2025-01-01", "postalCode": "78701", "primaryGroupCensusMemberId": null, "primaryMemberCategory": "Full-Time", "primaryMemberSource": "Workday", "relationshipToPrimaryMember": "Self", "smokerStatus": "Non-Smoker", "sourceSystemIdentifier": "WD-EMP-67890", "state": "TX", "status": "Active", "street": "456 Congress Ave" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Person account ID. | Optional | 65.0 | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_additional_fields_map_value.htm "Input representation for additional fields map value.")\[\] | List of key-value pairs for populating custom fields or other fields. | Optional | 65.0 | | annualEligibleSalary | Double | Annual salary that's eligible for benefits calculations. | Optional | 65.0 | | association​WithPrimaryMbr | String | Association to primary member for dependents, such as Spouse, Child. | Optional | 65.0 | | birthdate | String | Date of birth of the member, in YYYY-MM-DD format. | Optional | 65.0 | | city | String | City of the member's address. | Optional | 65.0 | | contactId | String | ID of the Contact record of the member. | Optional | 65.0 | | country | String | Country of the member's address. | Optional | 65.0 | | dependentCount | Integer | Number of dependents that are associated with the member. | Optional | 65.0 | | email | String | Email address of the member. | Optional | 65.0 | | firstName | String | First name of the member. | Required to add member | 65.0 | | fullTimeEquivalent | Double | Work capacity of the member, where 1.0 indicates a full-time employee. | Optional | 65.0 | | gender | String | Gender of the member. | Optional | 65.0 | | groupCensusId | String | ID of the Group Census that the member belongs to. | Optional | 65.0 | | groupClassId | String | ID for the specific class or category within the group that the member belongs to. | Optional | 65.0 | | groupClassName | String | Name of the group class. | Optional | 65.0 | | grpCensus​GrpClass​SummaryId | String | ID of the related group census group class summary record. | Optional | 65.0 | | id | String | ID of the group census member to update the member details. | Required to update member | 65.0 | | isOptOutAllPlans | Boolean | Indicates whether the member has opted out of all available insurance plans (true) or not (false). | Optional | 65.0 | | isPortalUser | Boolean | Indicates whether a community portal user must be created for this member (true) or not (false). | Optional | 65.0 | | joinDate | String | Date the member joined the group or company. | Optional | 65.0 | | lastname | String | Last name of the member. | Required to add member | 65.0 | | memberKey | String | Unique, externally defined key that's used for identifying and preventing duplicate members, often created by concatenating several fields. | Optional | 65.0 | | memberType | String | Type of member, such as Primary or Dependent. | Optional | 65.0 | | name | String | Full name of the member. | Optional | 65.0 | | optOutPlanTypes | String | Types of plans the member has opted out of. | Optional | 65.0 | | phoneNumber | String | Phone number of the member. | Optional | 65.0 | | policyStartDate | String | Date when the member's policy coverage begins. | Optional | 65.0 | | postalCode | String | Postal or ZIP code of the member's address. | Optional | 65.0 | | primary​GroupCensus​MemberId | String | ID of the primary group census member the dependents are associated with. | Optional | 65.0 | | primaryMember​Category | String | Category of the primary member. | Optional | 65.0 | | primaryMember​Source | String | System or source from which the member's data originated. | Optional | 65.0 | | relationship​To​PrimaryMember | String | Member's relationship to the primary insured. | Optional | 65.0 | | smokerStatus | String | Smoking status of the member, such as Smoker or Non-smoker. | Optional | 65.0 | | sourceSystem​Identifier | String | ID from an external source system, that's used for integration purposes. | Optional | 65.0 | | state | String | State or province the member belongs to. | Optional | 65.0 | | status | String | Current status of the member. | Optional | 65.0 | | street | String | Street address of the member. | Optional | 65.0 | # Group Census Member Plan Field Mapper (POST) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/actions/map-fields ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/actions/map-fields ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census whose fields are mapped in place. | Required | 68.0 | ## Request Body for POST ### JSON Example { "groupCensusFilters": { "memberPlanFilter": { "quoteId": "0Q0xx0000004CtoCAE" } }, "groupCensusReferenceMappings": { "memberPlanReferenceMapping": { "contractId": "800xx0000004C92AAE" } } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusFilters | [Group Census Filters Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_filters_input.htm "Input representation of the per-entity filters that scope which group census member plan records are processed.") | Filters that identify which records of the existing group census are processed. For example, process only the group census member plans that belong to a specified quote. | Optional | 68.0 | | groupCensusReferenceMappings | [Group Census Reference Mappings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_reference_mappings_input.htm "Input representation of the per-entity reference values saved to group census member plan records.") | Reference mapping rules that update group census records from a quote to a contract or from a contract to a quote. For example, remap quote line item references to contract group plans after a quote is converted to a contract. | Optional | 68.0 | ## Response Body for POST [Group Census Field Mapping Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_group_census_field_mapping.htm "Output representation of the details that are returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") # Group Census Member Plan Input Input representation for a single plan or coverage for a group census member. ## JSON Example { "contractGroupPlanId": "0s1xx000000001aEAA", "name": "Gold Tier Medical Plan", "attributes": { "values": \[ { "attributeCode": "Deductible", "attributeValue": "0" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_attribute_input.htm "Input representation of an overridden attribute value on a group census member plan.") \[\] | List of attribute-level changes that you want to make for the specific off-contract plan or coverage. Use this parameter to define custom values for individual plan attributes, such as deductibles, co-pays, or waiting periods, that differ from the base Product2 definition. | Optional | 68.0 | | contractGroupPlanId | String | ID of the contract group plan. | Required | 65.0 | | groupCensusMemberId | String | ID of the group census member. | Optional | 65.0 | | id | String | ID of the group census member plan record. | Required to update plan | 65.0 | | name | String | Name of the group census member plan. | Optional | 65.0 | | productCode | String | Product code of the Product2 record for the off-contract coverage overrides. Use this parameter to add a coverage that doesn’t exist in the member’s assigned contract group plan. | Required if contractGroupPlanId isn’t specified | 68.0 | | rootProductCode | String | Product code of the root product to which the off-contract coverage (defined by productCode) belongs. | Required if productCode is specified | 68.0 | # Group Census Members With Plans (POST, PATCH) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/members-with-plans ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/members-with-plans ## Available Version 68.0 ## HTTP Methods POST, PATCH ## Path Parameter for POST and PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census that the members and plans belong to. | Required | 68.0 | ## Request Body for POST ### JSON Example { "duplicateDetectionFields": \[ "FirstName", "LastName", "Email" \], "flowName": "Process Group Census Member Data", "shouldExecuteConfigurationRule": false, "members": \[ { "firstName": "Alex", "lastname": "Taylor", "email": "alex.taylor@example.com", "memberType": "Primary", "associationWithPrimaryMbr": "Self", "relationshipToPrimaryMember": "Self", "sourceSystemIdentifier": "WD-EMP-67890", "groupClassName": "Full-Time Salaried", "addedPlans": \[ { "contractGroupPlanId": "0gpxx0000000001AAA", "name": "Gold Tier Medical Plan", "attributes": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | duplicateDetectionFields | String\[\] | List of field API names that are used with the default fields to generate a unique key for identifying duplicate members. The default fields are FirstName, LastName, AssociationWithPrimaryMbr, Email, and GroupCensusId. | Optional | 68.0 | | flowName | String | Name of the flow to use for processing group census member data. The default value is Process Group Census Member Data. | Optional | 68.0 | | members | [Member With Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_with_plans_input.htm "Input representation of a group census member and the insurance plans to add or update for that member.")\[\] | List of group census members with their plan details to add or update. | Required | 68.0 | | shouldExecuteConfigurationRule | Boolean | Indicates whether the flow runs the eligibility and configurator engine when validating the submitted plans ( true) or saves the submitted plans as-is ( false). The default value is false. | Optional | 68.0 | ## Response Body for POST [Members With Plans Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_members_with_plans.htm "Details returned after a family of group census members and their plans is added or updated. The response includes a success flag, top-level errors, and per-member results.") ## Request Body for PATCH ### JSON Example { "duplicateDetectionFields": \[ "FirstName", "LastName", "Email" \], "flowName": "Process Group Census Member Data", "shouldExecuteConfigurationRule": false, "members": \[ { "firstName": "Alex", "lastname": "Taylor", "email": "alex.taylor@example.com", "memberType": "Primary", "associationWithPrimaryMbr": "Self", "relationshipToPrimaryMember": "Self", "sourceSystemIdentifier": "WD-EMP-67890", "groupClassName": "Full-Time Salaried", "addedPlans": \[ { "contractGroupPlanId": "0gpxx0000000001AAA", "name": "Gold Tier Medical Plan", "attributes": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | duplicateDetectionFields | String\[\] | List of field API names that are used with the default fields to generate a unique key for identifying duplicate members. The default fields are FirstName, LastName, AssociationWithPrimaryMbr, Email, and GroupCensusId. | Optional | 68.0 | | flowName | String | Name of the flow to use for processing group census member data. The default value is Process Group Census Member Data. | Optional | 68.0 | | members | [Member With Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_with_plans_input.htm "Input representation of a group census member and the insurance plans to add or update for that member.")\[\] | List of group census members with their plan details to add or update. | Required | 68.0 | | shouldExecuteConfigurationRule | Boolean | Indicates whether the flow runs the eligibility and configurator engine when validating the submitted plans ( true) or saves the submitted plans as-is ( false). The default value is false. | Optional | 68.0 | ## Response Body for PATCH [Members With Plans Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_members_with_plans.htm "Details returned after a family of group census members and their plans is added or updated. The response includes a success flag, top-level errors, and per-member results.") # Group Census Reference Mappings Input Input representation of the per-entity reference values saved to group census member plan records. ## JSON Example { "memberPlanReferenceMapping": { "contractId": "800xx0000004C92AAE", "quoteId": "0Q0xx0000004CtoCAE" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberPlanReferenceMapping | [Member Plan Reference Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_reference_mapping_input.htm "Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse.") | Reference mapping for group census member plan records. Use this mapping to associate source record references with corresponding target record references, for example from a quote to a contract or from a contract to a quote. | Optional | 68.0 | # Group Enrollment (POST) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/policies ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rlxx000000001aEAA/policies ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census whose members you want to enroll in their selected group benefit plans. | Required | 65.0 | ## Request Body for POST ### JSON Example { "batchJobName": "GroupBenefitsEnrollment\_Q1", "flowName": "MyEnrollmentFlow" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | batchJobName | String | Name that identifies the asynchronous batch job that enrolls the members of the group census. Use a descriptive value so that you can locate the job later when tracking its status. | Optional | 65.0 | | flowName | String | API name of an optional custom flow to run for each member as part of the bulk enrollment, endorsement, or renewal process. If you don't specify a value, the default Enroll Member flow is used. | Optional | 68.0 | ## Response Body for POST [Group Enrollment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_enrollment_output.htm "Output representation for the Group Enrollment API. Returns the asynchronous request ID for the bulk enrollment job, along with any errors that occurred before the job was scheduled.") # Group Enrollment Input Input representation for the Group Enrollment API. Use these properties to label the asynchronous bulk enrollment job and, optionally, to specify a custom flow to run for each member of the census. ## JSON Example { "batchJobName": "GroupBenefitsEnrollment\_Q1", "flowName": "MyEnrollmentFlow" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | batchJobName | String | Name that identifies the asynchronous batch job that enrolls the members of the group census. Use a descriptive value so that you can locate the job later when tracking its status. | Optional | 65.0 | | flowName | String | API name of an optional custom flow to run for each member as part of the bulk enrollment, endorsement, or renewal process. If you don't specify a value, the default Enroll Member flow is used. | Optional | 68.0 | # Group Enrollment Response Output representation for the Group Enrollment API. Returns the asynchronous request ID for the bulk enrollment job, along with any errors that occurred before the job was scheduled. ## JSON Example { "errors": \[\], "requestId": "a01RM0000004Hl1YAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while validating the request or scheduling the asynchronous group enrollment job. An empty list indicates that the job was scheduled successfully; per-member processing errors are reported by the asynchronous job itself, not in this response. | Small, 65.0 | 65.0 | | requestId | String | ID of the asynchronous bulk enrollment request. Use this ID to track the status of the group enrollment job. | Small, 65.0 | 65.0 | # Group Rating Input Input representation for the Group Benefits Group Rating API. ## JSON Example { "batchSize": 200, "quoteLineItemIds": \[ "0qvp00000004C9wAAE" \], "ratingDate": "2025-01-01" } ## Properties
Name Type Description Required or Optional Available Version
batchSize Integer Number of records to process in each batch for the rating calculation.

The default value is 5.

 Optional 65.0
quoteLineItemIds String[] List of quote line item IDs of the root plan. Optional 65.0
ratingDate String Date to use for the rating calculation. If not specified, the API uses the effective date of the quote. Optional 65.0
# Group Rating Response Output representation of the Group Benefits Group Rating process. ## JSON Example { "errors": \[\], "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [ConnectApi.ErrorResponse](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | List of errors that occurred during processing. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the group rating process is successful (true) or not (false). | Small, 65.0 | 65.0 | # Implement Quote Creation Functionality for Insurance Representatives This user journey applies when a policyholder contacts an insurance company and an insurance representative guides them through identifying coverage needs, configuring and pricing a quote, and sharing it for review. **Assumption** It’s assumed that a valid quote ID is available to update the existing quote. The insurance representative collects the policyholder's requirements and adds any other additional rules during the API call to create a quote. 1. **Create Quote**—Create a quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. This request returns a quote ID in the response. 2. **(Optional)Invoke Underwriting Review**—To invoke an underwriting review after the initial quote is created, make a POST request on the [Insurance Invoke Underwriting Rule](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_underwriting_rules_invoke.htm "HTML (New Window)") Connect API with the necessary inputs. 3. Use the quote ID that’s generated during the quote creation process for further processing, such as policy issuance. # Implement Quote Update Functionality for Insurance Representatives This user journey applies when a policyholder wants to update an existing quote, such as adding, deleting, or editing quote line items. **Assumption** It’s assumed that the insurance representative has collected the policyholder's requirements to update a quote. Use the quote ID to update the quote. 1. Make a PATCH request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API to update the quote. This request returns a new price-adjusted quote ID in the response. # Individual Enrollment and Policy Adjustment (POST, PUT) 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. ## Resource {memberId} is a placeholder. /connect/insurance/group-census-members/{memberId}/policies ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-census-members/0r6RM0000000h1pYAA/policies ## Available Version POST—65.0PUT—68.0 ## HTTP Methods POST, PUT ## Path Parameter for POST and PUT | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member. | Required | 65.0 | ## Request Body for POST ### JSON Example { "flowName": "MyEnrollmentFlow", "plan": "0gpp00000004C9wAAE", "shouldReprice": true } ### Properties
Name Type Description Required or Optional Available Version
flowName String API name of an optional flow to run as part of the enrollment process.

The default value is Process Group Census Member Data.

 Optional 65.0
plan String ID of the root contract group plan. Required 65.0
shouldReprice Boolean Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. Optional 68.0
## Response Body for POST [Individual Enrollment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_individual_enrollment_output.htm "Output representation for the Individual Enrollment API.") ## Request Body for PUT ### JSON Example { "flowName": "MyAdjustmentFlow", "plans": \[ "0gpp00000004C9wAAE" \], "shouldReprice": true } ### Properties
Name Type Description Required or Optional Available Version
flowName String API name of an optional custom flow to run as part of the mid-term adjustment. If you don't specify a value, the default flow is used.

The default value is Process Group Census Member Data.

 Optional 68.0
plans String[] IDs of the root contract group plans to adjust for the member. If not specified, the API adjusts every plan that the member is currently subscribed to. Optional 68.0
shouldReprice Boolean Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. Optional 68.0
## Response Body for PUT [Individual Mid-Term Adjustment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_individual_mta_output.htm "Output representation for the Individual Mid-Term Adjustment API.") # Individual Enrollment Input Input representation for individual enrollment. ## JSON Example { "flowName": "MyEnrollmentFlow", "plan": "0gpp00000004C9wAAE", "shouldReprice": true } ## Properties
Name Type Description Required or Optional Available Version
flowName String API name of an optional flow to run as part of the enrollment process.

The default value is Process Group Census Member Data.

 Optional 65.0
plan String ID of the root contract group plan. Required 65.0
shouldReprice Boolean Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. Optional 68.0
# Individual Enrollment Response Output representation for the Individual Enrollment API. ## JSON Example { "errors": \[\], "isSuccess": true, "policies": \[ { "plan": "Gold Plan", "policy": "0YTp00000004C9wAAE" } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that are encountered during the enrollment process. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the enrollment process is successful (true) or not (false). | Small, 65.0 | 65.0 | | policies | [Family Policy Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_family_policy_info_output.htm "Output representation for individual group policy information.")\[\] | List of policies that are created as part of the enrollment process. | Small, 65.0 | 65.0 | # Individual Mid-Term Adjustment Input Input representation for applying a mid-term adjustment to a group census member's insurance policies. ## JSON Example { "flowName": "MyAdjustmentFlow", "plans": \[ "0gpp00000004C9wAAE" \], "shouldReprice": true } ## Properties
Name Type Description Required or Optional Available Version
flowName String API name of an optional custom flow to run as part of the mid-term adjustment. If you don't specify a value, the default flow is used.

The default value is Process Group Census Member Data.

 Optional 68.0
plans String[] IDs of the root contract group plans to adjust for the member. If not specified, the API adjusts every plan that the member is currently subscribed to. Optional 68.0
shouldReprice Boolean Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. Optional 68.0
# Individual Mid-Term Adjustment Response Output representation for the Individual Mid-Term Adjustment API. ## JSON Example { "errors": \[\], "isSuccess": true, "policies": \[ { "plan": "Gold Plan", "policy": "0YTp00000004C9wAAE" } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that are encountered during the mid-term adjustment. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the mid-term adjustment is successful (true) or not (false). | Small, 68.0 | 68.0 | | policies | [Family Policy Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_family_policy_info_output.htm "Output representation for individual group policy information.")\[\] | List of policies that are created or updated as part of the mid-term adjustment. | Small, 68.0 | 68.0 | # Input Classes Some ConnectApi methods take arguments that are instances of ConnectApi input classes. Input classes are concrete unless marked abstract in this documentation. Concrete input classes have public constructors that have no parameters. Some methods have parameters that are typed with an abstract class. You must pass in an instance of a concrete child class for these parameters. Most input class properties can be set. Read-only properties are noted in this documentation. Insurance Design Advisor includes these Apex input classes. - **[ConnectApi.InsAttributeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_attribute.htm)** Input representation of one attribute definition to validate. Provide at least one of attribute ID, attribute code, or developer name. - **[ConnectApi.InsAttributeValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_attribute_validation.htm)** Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name. - **[ConnectApi.InsCMLModelValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_cml_model_validation.htm)** Input representation of the insurance products and related records to validate against the active CML model. - **[ConnectApi.InsGetRatingInputInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_get_rating_input.htm)** Input representation that specifies the product for which to generate a sample rating input payload. - **[ConnectApi.InsLookupErrorCodeInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_lookup_error_code.htm)** Input representation that specifies the insurance error code to look up. - **[ConnectApi.InsPricingSetupValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_pricing_setup_validation.htm)** Input representation of the quote, transaction type, and products to validate for pricing setup configuration. - **[ConnectApi.InsProductDiscoveryValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_product_discovery_validation.htm)** Input representation of the product to validate for discovery setup. Identify the product by ID, product code, or developer name. - **[ConnectApi.InsProductModelValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_product_model_validation.htm)** Input representation of the details to validate an insurance product model. - **[ConnectApi.InsRequestValidationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_request_validation.htm)** Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model. - **[ConnectApi.InsValidateUserPermissionsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_validate_user_permissions.htm)** Input representation that specifies the insurance operation and optional user ID for a permissions check. # InsPlcyLimitConsumptionRule Represents configuration for how policy limit consumption applies to an insurance policy product, including consumption mode and product binding. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Special Access Rules There are no additional access requirements that are specific to this type. ## Fields ### ConsumptionMode - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Specifies how the nested limits in the insurance policy are consumed when a claim is paid out. - **Possible values**: - Full ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name for the insurance policy limit consumption rule record. This name must begin with a letter and use only alphanumeric characters and underscores. It can't include spaces, end with an underscore, or have two consecutive underscores. ### IsEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the policy limit consumption configuration is enabled (true) or not (false). - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the insurance policy limit consumption rule. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for InsPlcyLimitConsumptionRule. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There’s an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that are Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There’s no namespace prefix for all other objects. ### PolicyProduct - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the root product for the insurance policy that this configuration applies to. # InsProductClauseVariableMap Represents the mapping between a token defined in an insurance clause and the product attributes that populate the token value at runtime. For example, a Free Look clause allows a customer to cancel a policy within a certain number of days. The number of days is a variable (or, token) that's populated using product-specific attributes. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Attribute - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the context attribute that's mapped to the variable. ### InsuranceProductClauseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: This field is a relationship field. - **Relationship Name**: InsuranceProductClause - **Relationship Type**: Master-detail - **Refers To**: InsuranceProductClause (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the insurance product clause mapping. ### VariableDataType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the variable used in the clause template. - **Possible values**: - boolean - currency - date - datetime - number - percent - picklist - reference - string ### VariableName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the variable used in the clause template. # Instance Key Input Input representation for a single instance key array. ## JSON Example { "instanceKey": \[ "Auto", "Liability" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | instanceKey | String\[\] | List of instance key strings that define a path. | Required | 65.0 | # Insurance Add Member Plans Output representation for the add member plans operation. ## JSON Example { "errors": \[\], "isSuccess": true, "memberId": "0r6xx000000001aEAA", "memberPlans": \[ "0rjxx00000000fx", "0rjxx00000000fy", "0rjxx00000000fz" \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | List of errors that occurred during the API operation. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API executed successfully (true) or not (false). | Small, 65.0 | 65.0 | | memberId | String | ID of the group census member. | Small, 65.0 | 65.0 | | memberPlans | String\[\] | List of IDs for the member plans that are successfully added. | Small, 65.0 | 65.0 | # Insurance Add Member Plans Input Input representation for adding plans to a census member. Use contractGroupPlanId to add standard plans defined in the group's contract, with the option to include attributes for granular overrides. Alternatively, use productCode and contractGroupPlanId to add off-contract coverages. When adding off-contract coverages, you can use the attributes parameter to define specific coverage details. productCode and contractGroupPlanId are mutually exclusive. You must provide one or the other based on whether the coverage is standard or off-contract. ## JSON Example { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "contractGroupPlanId": "0rgSG0000000eALYAY" } \] } } This is a sample example to add off-contract coverages. { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "productCode": "01tSG0000000abcDEF", "rootProductCode": "0rgSG0000000e8jYAA" } \] } } This is a sample example to add off-contract coverages with the attribute-level changes. { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA", "attributes": { "values": \[ { "attributeCode": "code", "attributeValue": "25" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusMemberPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of plans to add to the member. | Required | 65.0 | # Insurance Apex Reference Use built-in Apex classes grouped by namespace. - **[runtime\_industries\_insurance Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm)** The runtime\_industries\_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation. # Insurance App Usage Assignment Output representation for the insurance app usage assignment. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the application context of a sales transaction record. | Small, 66.0 | 66.0 | # Insurance Attribute Input Input representation of one attribute definition to validate. Specify at least one of attribute ID, attribute code, or developer name. ## JSON Example { "attributeId": "0QPxx0000004CAAQ", "attributeCode": "Make", "attributeName": "Vehicle\_Model" } ## Properties The API resolves each lookup in this order: attribute ID, then attribute code, and then developer name. If none of these properties is set, the corresponding result is invalid and instructions includes error code SF-INS-DSAV-00032. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeCode | String | Code of the attribute definition, such as Make or Deductible. The API uses this value when attributeId doesn’t resolve to an AttributeDefinition record. | Required if attributeId and attributeName aren’t specified | 68.0 | | attributeId | String | ID of the attribute definition record. This identifier takes precedence over attributeCode and attributeName. | Required if attributeCode and attributeName aren’t specified | 68.0 | | attributeName | String | Developer name of the attribute definition. The API uses this value when neither attributeId nor attributeCode resolves to an AttributeDefinition record. Matching is case-insensitive. For a dynamic context attribute, when you also specify contextDefinitionId, send the attribute’s dictionary name as configured in Setup. | Required if attributeId and attributeCode aren’t specified | 68.0 | # Insurance Attribute Validation Input Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name. ## JSON Example { "contextDefinitionId": "11Oxx0000004CXqEAM", "attributeLookups": \[ { "attributeId": "0QPxx0000004CAAQ" }, { "attributeCode": "Make" }, { "attributeName": "Vehicle\_Model" }, { "attributeCode": "SF-INS-DSAV-00032" }, {} \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeLookups | [Insurance Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_attribute_input.htm "Input representation of one attribute definition to validate. Specify at least one of attribute ID, attribute code, or developer name.")\[\] | Attribute definitions to validate. Each entry identifies one attribute definition by ID, code, or developer name. The API confirms that each definition exists in the org and is active. Results are returned in the same order as this list. | Required | 68.0 | | contextDefinitionId | String | ID of the context definition. When you specify this ID, dynamic context attributes, such as attributes whose names start with DYN\_\_INS\_\_, are resolved against that context definition’s dynamic-attributes catalog before the API looks up AttributeDefinition records. | Optional | 68.0 | # Insurance Attribute Validation Response Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn’t. ## JSON Example { "isValid": false, "attributes": \[ { "attributeId": "0QPxx0000004CAAQ", "isValid": true }, { "attributeCode": "Make", "isValid": true }, { "attributeName": "Vehicle\_Model", "isValid": false, "instructions": \[ { "code": "SF-INS-DSAV-00031", "message": "The specified attribute exists but is not active." } \] }, { "attributeCode": "NonExistentCode", "isValid": false, "instructions": \[ { "code": "SF-INS-DSAV-00030", "message": "The specified attribute was not found." } \] }, { "isValid": false, "instructions": \[ { "code": "SF-INS-DSAV-00032", "message": "At least one of attributeId, attributeCode, or attributeName must be provided." } \] } \], "errors": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | [Insurance Attribute Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_attribute_validation_result.htm "Output representation of the validation result for one attribute lookup. The result echoes the identifiers from the request and includes resolution guidance when the attribute definition can’t be validated.")\[\] | Validation result for each attribute lookup, in the same order as the request. Each result includes the identifiers from the request and reports whether that attribute definition is valid. | Big, 68.0 | 68.0 | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | Top-level errors that occurred before per-attribute validation runs, such as a missing request body, an empty lookup list, insufficient access, or an unexpected server error. This list is empty when validation runs for each lookup. Per-attribute failures are returned in attributes, not in this list. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether every attribute lookup is valid (true) or not (false). This value is true when every per-attribute result is valid, and false when any result is invalid. | Big, 68.0 | 68.0 | # Insurance Attribute Validation Result Output representation of the validation result for one attribute lookup. The result echoes the identifiers from the request and includes resolution guidance when the attribute definition can’t be validated. ## JSON Example { "attributeName": "Vehicle\_Model", "isValid": false, "instructions": \[ { "code": "SF-INS-DSAV-00031", "message": "The specified attribute exists but is not active." } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributeCode | String | Code of the attribute definition that corresponds to the value specified in the request. | Big, 68.0 | 68.0 | | attributeId | String | ID of the attribute definition record that corresponds to the value specified in the request. | Big, 68.0 | 68.0 | | attributeName | String | Developer name of the attribute definition that corresponds to the value specified in the request. | Big, 68.0 | 68.0 | | instructions | [Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm "Output representation of one validation diagnostic, including the error code and message.")\[\] | Resolution guidance for this attribute when the attribute is invalid. Each entry includes an error code and a message. Omitted or empty when the attribute is valid. Per-attribute failures use SF-INS-DSAV-00030 when the attribute definition isn’t found, SF-INS-DSAV-00031 when it is inactive, and SF-INS-DSAV-00032 when the lookup doesn’t include an attribute ID, code, or developer name. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether this attribute definition exists and is active (true) or not (false). | Big, 68.0 | 68.0 | # Insurance Billing Schedules (POST) Create billing schedules from insurance policy transactions to generate financial records for policy lifecycle events. This API automates the creation of billing schedules and invoices for key policy events, including Issuance, Endorsement, Cancellation, and Renewal. The service supports complex scenarios such as out-of-sequence endorsements and cancellations by calculating transient transactions to ensure accurate net billing. ## Resource /connect/insurance/billing/billing-schedules ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/billing/billing-schedules ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "insPolicyTransactionId": "0k9xx0000000001AAA" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insPolicy​TransactionId | String | ID of the insurance policy transaction record to get related transaction details and billing configuration. | Required | 66.0 | ## Response Body for POST [Insurance Billing Schedules Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_billing_output.htm "Details of the billing schedule creation results.") # Insurance Billing Schedules Input Details for creating billing schedules from an insurance transaction. ## JSON Example { "insPolicyTransactionId": "0k9xx0000000001AAA" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insPolicy​TransactionId | String | ID of the insurance policy transaction record to get related transaction details and billing configuration. | Required | 66.0 | # Insurance Billing Schedules Response Details of the billing schedule creation results. ## JSON Example { "errors": \[\], "message": "Billing schedules created successfully." } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response \[\]](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm) | List of errors that are encountered during the billing process. | Small, 66.0 | 66.0 | | message | String | Text message of the API request. | Small, 66.0 | 66.0 | # Insurance Brokerage Use the Insurance Brokerages developer resources to automate processes related to Policy and Commissions Management. Invoke policy lifecycle services such as Renew, Repurpose, and Cancel using context service. Manage plan benefits using a flexible service layer and Product Catalog.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
- **[Insurance Brokerage Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_business_api_overview.htm)** Use the Insurance Brokerage Business APIs to manage policy lifecycle, brokerage commissions, and plan benefits. - **[Insurance Brokerage Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_invocable_actions_parent.htm)** Learn more about the standard invocable actions available with Insurance Brokerage. - **[Insurance Brokerage Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. - **[Insurance Brokerage Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_apex_reference.htm)** Apex is a strongly typed, object-oriented programming language that developers can use to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Brokerage Apex reference includes built-in Apex classes and interfaces, grouped by namespace. # Insurance Brokerage Apex Reference Apex is a strongly typed, object-oriented programming language that developers can use to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Brokerage Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_connect_api_namespace.htm)** The ConnectApi namespace (also called Connect in Apex) in Insurance Brokerage provides classes for accessing the same data available in the Insurance Brokerage Business APIs. # Insurance Brokerage Business APIs Use the Insurance Brokerage Business APIs to manage policy lifecycle, brokerage commissions, and plan benefits. This table lists the available Insurance Brokerage resources. | Resource | Description | | --- | --- | | [/connect/insurance/brokerage/commission/process](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_commission_processing.htm "Process commission statements in an asynchronous manner using a preconfigured batch job.") (POST) | Process commission statements in an asynchronous manner using a preconfigured batch job. | | [/connect/insurance/brokerage/policies/policyId/expected-rates](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cost_calculation.htm "Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. The InsuranceRatePlanLineItem premium, fees, or premium equivalent amount is rolled up to the Insurance Rate Plan, Insurance Coverage, and Insurance Policy Premium Amount.") (PATCH) | Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. | | [/connect/insurance/brokerage/policies/policyId/expected-revenue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_expected_revenue.htm "Calculate the expected revenue, derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. The expected revenue amount is rolled up from Insurance Rate Plan to Insurance Coverage and Insurance Policy expected revenue amount.") (PATCH) | Calculate the expected revenue, which is derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. | | [/connect/insurance/brokerage/coverages/coverageId/benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_plan_benefits.htm "Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage.") (POST) | Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage. | | [/connect/insurance/brokerage/coverages/coverageId/benefits/product](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_plan_benefits_product_model.htm "Get the product model details along with child components and their attributes for a given insurance policy coverage.") (GET) | Get the product model details along with child components and their attributes for a given insurance policy coverage. | | [/connect/insurance/brokerage/policies/policyId/issue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_issue_policy.htm "Issue a policy using the policy ID.") (PATCH) | Issue a policy for the specified insurance policy ID. | | [/connect/insurance/brokerage/policies/policyId/endorse](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_endorse_policy.htm "Create an endorsement policy draft or complete endorsing a policy by using the insurance policy ID.") (POST, PATCH) | Endorse a policy or create a draft endorsement for the specified insurance policy ID. | | [/connect/insurance/brokerage/policies/policyId/cancel](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_cancel_policy.htm "Cancel an insurance policy.") (PATCH) | Cancel an insurance brokerage policy. | | [/connect/insurance/brokerage/policies/policyId/reinstate](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_reinstate_policy.htm "Reinstate a canceled policy for the specified insurance policy ID.") (POST) | Reinstate a canceled policy for the specified insurance policy ID. | | [/connect/insurance/brokerage/policies/policyId/renew](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_renew_policy.htm "Renew policy for the specified insurance policy ID.") (POST) | Renew policy for the specified insurance policy ID. | | [/connect/insurance/billing/billing-schedules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_billing.htm "Create billing schedules from insurance policy transactions to generate financial records for policy lifecycle events.") (POST) | Create billing schedules from insurance policy transactions to generate financial records for policy lifecycle events. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_business_apis_resources.htm)** Learn about the available Insurance Brokerage API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_business_apis_requests.htm)** Learn about the available Insurance Brokerage API requests. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_business_apis_responses.htm)** Learn about the response bodies of Insurance Brokerage APIs. # Insurance Brokerage Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Brokerage. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Brokerage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_brokerage_flow_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Brokerage exposes additional actionType values for the FlowActionCall Metadata type. # Insurance Brokerage Standard Invocable Actions Learn more about the standard invocable actions available with Insurance Brokerage. - **[Cancel Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_cancel_ins_brokerage_policy.htm)** Cancel an insurance brokerage policy with optional cancellation details such as effective date, reason, and target status. - **[Compute Producer Splits Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_compute_producer_splits.htm)** Compute the producer splits for the producers associated with an Insurance Policy, for a Commission Statement Line Item. - **[Create Producer Commissions Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_producer_commissions.htm)** Create records for the commissions that producers receive for the insurance policy associated with the specified commission statement line item, and update the commission statement line item record status. - **[Create Endorsement Draft for Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_draft_ins_brokerage_policy.htm)** Start an endorsement draft of an insurance brokerage policy with optional policy detail overrides. - **[Endorse Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_ins_brokerage_policy.htm)** Complete an in-progress endorsement of an insurance brokerage policy. - **[Find Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_find_insurance_policy.htm)** Get the insurance policy associated with a commission statement line item that matches the specified criteria, and update the status of the commission statement line item record. - **[Issue Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_ins_brokerage_policy.htm)** Issue an insurance brokerage policy by specifying the policy ID. - **[Preview Policy Premium Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_preview_policy_premium.htm)** Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes. - **[Reinstate Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_reinstate_ins_brokerage_policy.htm)** Reinstate a canceled insurance brokerage policy with optional reinstatement details. - **[Renew Insurance Brokerage Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_ins_brokerage_policy.htm)** Renew an insurance brokerage policy with optional policy detail overrides. # Insurance Bulk Census Management (POST) Process group census data in bulk. This API efficiently manages large volumes of member data that are linked to a specific group census ID, simplifying the enrollment and update process for group insurance plans. When processing enrollment census data, this API also updates the member plan details. ## Resource {groupCensusId} is a placeholder. /connect/insurance/census-management/group-censuses/{groupCensusId}/group-census-members/bulk-process ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-censuses/0rlxx000000001aEAA/group-census-members/bulk-process ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusId | String | ID of the group census. | Required | 65.0 | ## Request Body for POST ### JSON Example { "batchSize": 200, "contentDocumentId": "069SG000003gLazYAE", "contentDocumentVersionId": "0688d0000025fA3AAI", "duplicateDetectionFields": { "values": \[ "FirstName", "Lastname" \] }, "csvColumnMapping": { "data": { "First Name": "FirstName", "Last Name": "Lastname", "Email": "Email", "Birthdate": "Birthdate", "Gender": "Gender", "Relationship to Primary Member": "AssociationWithPrimaryMbr", "Medical": "ContractGroupPlan", "Dental": "ContractGroupPlan", "Group Class": "GroupClassName" } }, "shouldExecuteConfigurationRule": false } ### Properties
Name Type Description Required or Optional Available Version
batchSize Integer Number of CSV records to process in each batch.

The default size for Quote Census is 2000.

The default size for Enrollment Census is 25.

 Optional 65.0
content​DocumentId String ID of the content document (CSV file) to process. Required 65.0
contentDocument​VersionId String ID of the specific version of the content document. Optional 65.0
csvColumnMapping Map<String, String> Map where the key is the CSV column header and the value is the API name of the corresponding field in the GroupCensusMember object. Required 65.0
duplicate​Detection​Fields String[] List of field API names that are used to generate a unique key for identifying duplicate members along with the default values.

The default fields that are used to detect duplication are FirstName, LastName, groupCensusId, and AssociationWithPrimaryMbr.

Optional 65.0
shouldExecute​Configuration​Rule Boolean Indicates whether to execute the configuration rules after processing the data ( true) or not ( false).

The default value is false.

Optional 65.0
## Response Body for POST [Bulk Group Census Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_bulk_census_mgmt_output.htm "Output representation for the bulk processing of employee census data.") # Insurance Census Filter Input Input representation of the filter criteria that select which policy records to include when generating a group census from a contract. ## JSON Example { "contractGroupPlanIds": \[ "0gpxx0000000001AAA" \], "objectName": "Contact", "recordIds": \[ "003xx000004WhKhAAK" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractGroupPlanIds | String\[\] | IDs of the root contract group plans to include when generating the group census. | Optional | 68.0 | | objectName | String | API name of the object that the specified member record IDs belong to, such as Contact or PersonAccount. | Optional | 68.0 | | recordIds | String\[\] | IDs of the specific records to include when generating the group census. Valid values are contact IDs and person account IDs. The IDs must belong to the object specified in objectName. | Optional | 68.0 | # Insurance Census Summary Sync (POST) Synchronize and recalculate the summary data for a group census. This API uses the group census ID to synchronize the group census summary and group census group class summary data. This API doesn't require a request payload. ## Resource {groupCensusId} is a placeholder. /connect/insurance/census-management/group-censuses/{groupCensusId}/sync-summary ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-censuses/0rlxx000000001aEAA/sync-summary ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusId | String | ID of the group census. | Required | 65.0 | ## Response Body for POST [Insurance Census Summary Sync Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_summary_sync_output.htm "Output representation of an employee census summary synchronization.") # Insurance Census Summary Sync Details Output representation of an employee census summary synchronization. ## JSON Example { "isSuccess": true, "errors": null, "groupCensus": { "id": "a0B1x000000XXXXX", "memberOptOutCount": 5, "mbrWithoutDependentCount": 20, "memberWithOneChildCount": 15, "mbrWithMoreThan1ChldCount": 10, "mbrWithMoreThan2ChldCount": 5, "memberWithDependentCount": 30, "memberWithSpouseCount": 25, "totalMemberPlusDependent": 85, "totalDependents": 45, "totalMembers": 40, "fullTimeMemberCount": 35, "partTimeMemberCount": 5, "grpCensusGrpClassSummaryList": \[ { "id": "a0C1x000000YYYYY", "groupCensusId": "a0B1x000000XXXXX", "groupClassId": "a0D1x000000ZZZZZ", "memberOptOutCount": 2, "mbrWithoutDependentCount": 10, "memberWithOneChildCount": 5, "mbrWithMoreThan1ChldCount": 3, "mbrWithMoreThan2ChldCount": 2, "memberWithDependentCount": 10, "memberWithSpouseCount": 8, "totalMemberPlusDependent": 28, "totalDependents": 15, "totalMembers": 13, "fullTimeMemberCount": 12, "partTimeMemberCount": 1 } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | List<[ConnectApi.ErrorRepresentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\> | List of errors that occurred during processing. | Small, 65.0 | 65.0 | | groupCensus | [Insurance Group Census Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_census_output.htm "Output representation of group census summary data.") | Summary details for the group census. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | Small, 65.0 | 65.0 | # Insurance Claims Apex Reference Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Claims Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_connect_api_namespace.htm)** The ConnectApi namespace (also called Connect in Apex) in Insurance Claim provides classes for accessing the same data available in the Insurance Policy Administration Business APIs. # Insurance Claims Business APIs Use the Insurance Claims APIs to manage claims lifecycle. - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_business_apis_resources.htm)** Learn more about the available Insurance Claims API. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_business_apis_requests.htm)** Learn more about the available requests of insurance claim APIs. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_business_apis_responses.htm)** Learn more about the available response bodies of insurance claim APIs. # Insurance Claims Developer Journey Learn how to effectively use the Insurance Claims Connect APIs, along with the associated invocable actions, to automate end-to-end claims processing workflows, from initial coverage verification to final payment settlement or cancellation by using Salesforce Flows and Omniscripts. This guide walks you through the complete claims lifecycle, explaining: - The business scenario behind a claim. - The sequence of API calls across the Claims and Financial domains. - The data states and system transitions at each step. - The standard claim resolution flow for successful payments. - The exception paths for voiding or canceling payments. | Key TERMS | DESCRIPTIONS | | --- | --- | | Coverage Validation | Confirms policy status, coverage type, and claim eligibility. | | Claim Coverage Payment Detail (CCPD) | The payment record that’s created for each coverage-level payment request. | | Claim Status | Represents lifecycle stages, such as Submitted, Pending Review, Approved, and Paid. | | Deductible | The portion of loss the policyholder pays before insurer coverage applies. | | Limit | The maximum payout that’s allowed for a policy coverage type. | - **[Claims Processing Journey](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/claims_workflow.htm)** A claim is a formal request submitted by a policyholder to receive benefits or compensation for a covered loss under an active insurance policy. A claim journey begins when the policyholder reports an incident, such as damage, injury, or another qualifying event that they believe is covered by their policy. # Insurance Claims Management Use the Insurance Claims developer resources to set up claim products and create dynamic first notice of loss intake flows for your users. Give claim adjusters a cohesive view of claims and financial data so they can efficiently assess and settle claims. Establish financial controls and automatically route requests for financial approval to the appropriate supervisors and managers.
View supported editions.
- **[Insurance Claims Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_business_api_overview.htm)** Use the Insurance Claims APIs to manage claims lifecycle. - **[Insurance Claims Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_invocable_actions_parent.htm)** Learn more about the standard invocable actions available with Insurance Claims. - **[Insurance Claims Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claims_apex_reference.htm)** Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Claims Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[Insurance Claims Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. - **[Insurance Claims Tooling API Objects](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_tooling_api_parent.htm)** Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. - **[Insurance Claims Developer Journey](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurace_claims_dev_journey.htm)** Learn how to effectively use the Insurance Claims Connect APIs, along with the associated invocable actions, to automate end-to-end claims processing workflows, from initial coverage verification to final payment settlement or cancellation by using Salesforce Flows and Omniscripts. # Insurance Claims Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Claims. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Claims](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_claim_flow_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Claim exposes additional actionType values for the FlowActionCall Metadata type. - [InsPlcyLimitConsumptionRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_insplcyLimitconsumptionrule.htm) Represents configuration for how policy limit consumption rule applies to an insurance policy product, including consumption mode and product binding. # Insurance Claims Standard Invocable Actions Learn more about the standard invocable actions available with Insurance Claims. - **[Bulk Pay Claim Coverage Payment Details Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_pay_claim_cvr_payment_detail_in_bulk.htm)** Process payments for Claim Coverage Payment Detail (CCPD) records in bulk. - **[Calculate Adjustments Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_calculate_adjustments.htm)** Calculate the adjusted amount for a loss item and generate data for insurance policy limit tracking and claim coverage payment adjustment records. - **[Cancel Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_cancel_claim_coverage_payment_detail.htm)** Cancel payment for a claim coverage payment detail record. - **[Create Claim Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_claim.htm)** Create a claim. - **[Create Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_claim_coverage_payment_detail.htm)** Create a claim coverage payment detail record. - **[Create Policy Limits Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_policy_limits.htm)** Create insurance policy limit records for policy coverage and root attributes. - **[Check Financial Authority Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_check_financial_authority.htm)** Check whether the currently authenticated user has sufficient financial authority to approve a claim coverage payment detail record. - **[Delete Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_delete_claim_coverage_payment_detail.htm)** Remove unpaid claim coverage payment details by updating the status of the claim coverage payment detail record to Deleted. - **[Edit Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_edit_claim_cvr_payment_detail.htm)** Modify a claim coverage payment detail record. - **[Get Claim Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_claim.htm)** Get the details of a claim. - **[Get Insurance Policy Current Standings Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy_current_standings.htm)** Get the current standings of the insurance policy. - **[Open Claim Coverage Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_open_claim_coverage.htm)** Open a claim coverage. - **[Pay Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_pay_claim_coverage_payment_detail.htm)** Initiate the payment for a claim coverage payment detail record, track the policy limit consumption for the payout, and update the status of the claim coverage payment detail record to Paid. - **[Pay Ex Gratia Claim Coverage Payment Detail Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_pay_ex_gratia_claim_cvr_payment_detail.htm)** Process ex gratia payments for the claim coverage payment detail record when the adjusted amount is greater than the policy limit amount or count or both. - **[Recalculate Adjustments Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_recalculate_adjustments.htm)** Recalculate the adjusted amount for a claim loss item to the maximum amount that’s allowed by the insurance policy. - **[Update Claim Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_claim.htm)** Update a claim. - **[Update Claim Coverage Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_claim_coverage.htm)** Update a claim coverage. - **[Verify Policy Coverage Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_verify_policy_coverage.htm)** Verify whether a policy coverage is applicable for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. # Insurance Claims Tooling API Objects Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. - **[InsPlcyLimitConsumptionRule](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/tooling_api_objects_insplcylimitconsumptionrule.htm)** Represents configuration for how policy limit consumption applies to an insurance policy product, including consumption mode and product binding. This object is available in API version 67.0 and later. # Insurance CML Model Validation Input Input representation of the insurance products and related records to validate against the active CML model. ## JSON Example { "productIds": \["01txx0000006iPnAAI"\], "productSurchargeIds": \["0nSxx0000001DDDAAI"\], "productClauseIds": \["0nPxx0000001EEEAAI"\], "underwritingRuleIds": \["0nUxx0000001FFFAAI"\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauseIds | String\[\] | List of insurance product clause IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | | productIds | String\[\] | List of root product IDs to be validated. For each ID, the API verifies that the product has an active CML model associated with it. | Required | 68.0 | | productSurchargeIds | String\[\] | List of product surcharge IDs to validate against the active CML model that’s identified by productIds. For each surcharge, the API checks whether the record exists, and whether every segment of its ProductPath is referenced by the active CML association. Don’t specify this property if you don’t want to validate surcharges for the products. | Optional | 68.0 | | underwritingRuleIds | String\[\] | List of underwriting rule IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | # Insurance CML Model Validation Response Output representation of the per-record validation results and any top-level errors that occur when processing the request. ## JSON Example { "isValid": false, "results": \[ { "recordId": "01txx0000006iPnAAI", "recordType": "Product", "isValid": true }, { "recordId": "0nSxx0000001DDDAAI", "recordType": "ProductSurcharge", "productPath": "01txx0000006iPnAAI/01txx0000006iPnBBB", "isValid": false, "instructions": "One or more products in the product path aren't referenced by the active CML model. Update the product path or associate the products with the CML model." }, { "recordId": "0nUxx0000001FFFAAI", "recordType": "UnderwritingRule", "isValid": true, "instructions": "BRE-based rule (no CML RuleKey), skipping CML validation" } \], "errors": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | Request-level errors that occurred before per-record validation runs. This property doesn’t contain per-record validation failures. Those appear inside results with isValid set to false. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether the CML model validation passed for every record (true) or not (false). This value is true when every per-record result is valid, and false when any result is invalid. | Big, 68.0 | 68.0 | | results | [Insurance CML Model Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_cml_model_validation_result.htm "Output representation of the validation result for a single record. When the record isn’t valid, the instructions paramter describes the failure and recommended correction.")\[\] | Validation results for each specified record. This property contains one entry for every specified record across productIds, productSurchargeIds, productClauseIds, and underwritingRuleIds. It shows an empty list on a request-level error. | Big, 68.0 | 68.0 | # Insurance CML Model Validation Result Output representation of the validation result for a single record. When the record isn’t valid, the instructions paramter describes the failure and recommended correction. ## JSON Example { "recordId": "0nSxx0000001DDDAAI", "recordType": "ProductSurcharge", "productPath": "01txx0000006iPnAAI/01txx0000006iPnBBB", "isValid": false, "instructions": "One or more products in the product path aren't referenced by the active CML model. Update the product path or associate the products with the CML model." } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | instructions | String | Human-readable resolution guidance that describes the reason for a validation failure and how to resolve it. This property contains details when isValid is false. For valid results, this property is either omitted or contains informational context, such as when a BRE-based underwriting rule has no CML rule key. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether this record passed validation (true) or not (false). When false, see instructions for the failure reason and correction. | Big, 68.0 | 68.0 | | productPath | String | ProductPath field value from the validated record. This property is shown only when recordType is ProductSurcharge or InsuranceProductClause. | Big, 68.0 | 68.0 | | recordId | String | ID of the record that’s validated. | Big, 68.0 | 68.0 | | recordType | String | Type of record. Valid values are Product, ProductSurcharge, InsuranceProductClause, and UnderwritingRule. | Big, 68.0 | 68.0 | # Insurance Commission Processing Input Input representation details of insurance commission processing. ## JSON Example { "commissionStatementIds": \[ "199TC0000003kxZYAQ" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | commissionStatementIds | Object | List of commission statement IDs to be processed. | Required | 63.0 | # Insurance Configurator Message Output representation of configurator messages. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | Insurance quote configurator message. | Small, 63.0 | 63.0 | | type | String | Type of message. | Small, 63.0 | 63.0 | | recordId | String | Record ID. | Small, 66.0 | 66.0 | # Insurance Contacts and Users (POST) 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. ## Resource /connect/insurance/contacts ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contacts?createPortalUsers=false ## Available Version 65.0 ## HTTP Methods POST ## Request Parameters for POST
Parameter Name Type Description Required or Optional Available Version
createPortalUsers Boolean Indicates whether to create portal users for the new contacts (true) or not (false).

The default value is true.

 Optional 65.0
## Request Body for POST ### JSON Example This is a sample JSON example with GroupCensusId. { "groupCensusId": "0rfxx0000000007AAA", "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } This is a sample JSON example with GroupCensusMembers. { "groupCensusMemberIdList": { "values": \[ "0r6xx0000000002AAA", "0r6xx000000004rAAA" \] }, "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } ### Properties
Name Type Description Required or Optional Available Version
fieldMappings Map Map of field API names from the Group Census Member object (key) to the Contact object (value). Optional 65.0
groupCensusId String ID of the group census. Optional 65.0
groupCensusMember​IdList String[] IDs of the group census members for whom you want to create contacts and users.

If not provided, all members of the specified group census are processed.

 Optional 65.0
matchingKeyList String[] List of field API names on the Group Census Member object that are used to identify and prevent the creation of duplicate contact records.

The default fields are FirstName, LastName, Birthdate, Email, and Gender.

 Optional 65.0
userDetails Portal User Creation Input Details to create portal users.

This property is required if the createPortalUsers parameter in the method call is set to true.

Optional 65.0
## Response Body for POST [Insurance Contacts and Users Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contacts_and_users_creation_output.htm "Output representation of the contact and user creation process.") # Insurance Contacts and Users Creation Input Input representation for creating contacts and portal users from group census members. ## JSON Example This is a sample JSON example with GroupCensusId. { "groupCensusId": "0rfxx0000000007AAA", "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } This is a sample JSON example with GroupCensusMembers. { "groupCensusMemberIdList": { "values": \[ "0r6xx0000000002AAA", "0r6xx000000004rAAA" \] }, "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } ## Properties
Name Type Description Required or Optional Available Version
fieldMappings Map Map of field API names from the Group Census Member object (key) to the Contact object (value). Optional 65.0
groupCensusId String ID of the group census. Optional 65.0
groupCensusMember​IdList String[] IDs of the group census members for whom you want to create contacts and users.

If not provided, all members of the specified group census are processed.

 Optional 65.0
matchingKeyList String[] List of field API names on the Group Census Member object that are used to identify and prevent the creation of duplicate contact records.

The default fields are FirstName, LastName, Birthdate, Email, and Gender.

 Optional 65.0
userDetails Portal User Creation Input Details to create portal users.

This property is required if the createPortalUsers parameter in the method call is set to true.

Optional 65.0
# Insurance Contacts and Users Creation Response Output representation of the contact and user creation process. ## JSON Example This is a sample JSON example for a successful API request. { "isSuccess": true, "groupCensusId": "0rfAbcDefGhiJklMno", "contactsAndUsersDetails": \[ { "groupCensusId": "0rfAbcDefGhiJklMno", "groupCensusMemberId": "0r6PrimaryMemberId", "contactId": "003abc123DEF456ghi" }, { "groupCensusId": "0rfAbcDefGhiJklMno", "groupCensusMemberId": "0r6DependentMemberId", "contactId": "003stu456VWX789yz" } \], "errors": \[\] } This is a sample JSON example with error. { "contactsAndUsersDetails": \[ { "groupCensusId": "0rfxx00000001Qr", "groupCensusMemberId": "0r6xx00000002sB", "contactId": "001xx000003Gdl5AAC" }, { "groupCensusId": "0rfxx00000001Qr", "groupCensusMemberId": "0r6xx00000002sC", "contactId": "001xx000003Gdl5BAC" } \], "errors": \[ { "additionalInfo": {}, "code": "SF-0004-0047", "message": "Ensure to set the isPortalUser flag to true for group census members 0r6xx00000002sB,0r6xx00000002sC." } \], "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contactsAnd​UsersDetails | [Insurance Member Contact and User Details\[\]](connect_responses_insurance_member_contact_and_user_details_output.htm "Output representation of a member's contact and portal user details that's created.") | Details of contacts and users that are created. | Small, 65.0 | 65.0 | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Errors that occurred during the process. | Small, 65.0 | 65.0 | | groupCensusId | String | ID of the group census that's processed. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the operation is successful (true) or not (false). | Small, 65.0 | 65.0 | # Insurance Contract Endorse Input Input representation of the details, such as quote ID, endorsement effective date, optional enrollment window, and additional fields to create an endorsed contract version from a quote. ## JSON Example { "quoteId": "0Q0xx0000004CtoCAE", "effectiveDate": "2026-02-01", "updateExistingContractDates": false, "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to add to contract items. | Optional | 68.0 | | effectiveDate | String | Effective date of endorsement that indicates the start date of the endorsed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | quoteId | String | ID of the quote for contract endorsement. | Required | 68.0 | | updateExistingContractDates | Boolean | Indicates whether to update dates on the existing contract when creating the endorsed contract version (true) or not (false). | Optional | 68.0 | # Insurance Contract Item Input Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote. ## JSON Example { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | API name of the object to apply the additional field values to, such as Contract, InsuranceContract, or ContractGroupPlan. | Optional | 68.0 | | fields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | List of key-value pairs that represent the fields and their values for the entity. | Optional | 68.0 | | productPath | String | Product path that identifies where in the contract structure the additional fields apply. | Optional | 68.0 | # Insurance Contract Renewal Input Input representation of the details, such as the quote ID, renewal and contract end dates, and optional enrollment window, term, target contract, and additional fields to create a renewed-term contract from a quote. ## JSON Example { "quoteId": "0Q0xx0000004CtoCAE", "renewalDate": "2026-03-11", "contractEndDate": "2027-03-11", "contractTerm": 12, "targetContractId": "800xx0000004C92AAE", "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to apply to contract objects when the renewed contract is created. | Optional | 68.0 | | contractEndDate | String | End date of the renewed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | contractTerm | Integer | Duration of the renewed contract in months. The default value is 12. | Optional | 68.0 | | quoteId | String | ID of the quote from which you want to create the renewed contract. | Required | 68.0 | | renewalDate | String | Date that the renewed contract term starts. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | targetContractId | String | ID of the existing contract that the renewal is based on, when you need to identify the prior contract explicitly. | Optional | 68.0 | # Insurance Contract Transactions Generation Input Input representation of the date range and job name to generate contract transactions for a group benefits contract. ## JSON Example { "name": "Q1-2026-Transactions", "fromDate": "2026-01-01", "toDate": "2026-03-31" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fromDate | String | Start date of the time period for which you want to generate contract transactions, in YYYY-MM-DD format. | Required | 68.0 | | name | String | Name of the transaction generation job. Use a descriptive name so that you can identify the job later. | Optional | 68.0 | | toDate | String | End date of the time period for which to generate contract transactions, in YYYY-MM-DD format. Must be on or after the fromDate. | Required | 68.0 | # Insurance Contract Transactions Generation Response Output representation of the details when you start asynchronous generation of contract transactions for a group benefits contract. ## JSON Example { "isSuccess": true, "message": "Transaction generation started successfully", "jobIdentifier": "08Pxx0000000001EAA", "errors": null } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while starting transaction generation. Shows null when the request succeeds. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the transaction generation request started successfully (true) or not (false). | Small, 68.0 | 68.0 | | jobIdentifier | String | ID of the asynchronous job that generates the contract transaction. Use this ID to track the job status. | Small, 68.0 | 68.0 | | message | String | Status message for the transactions generation request. | Small, 68.0 | 68.0 | # Insurance Contribution Output representation of contribution information in an individual rating. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | employee​PremiumAmount | Double | Premium amount that's contributed by an employee. | Small, 65.0 | 65.0 | | employer​PremiumAmount | Double | Premium amount that's contributed by an employer. | Small, 65.0 | 65.0 | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details. | Small, 65.0 | 65.0 | | groupClass​ContributionId | String | ID of the contribution record. | Small, 65.0 | 65.0 | # Insurance Coverage Rating Output representation of an individual coverage's pricing result. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contributions | [Insurance Contribution](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contribution_output.htm "Output representation of contribution information in an individual rating.") | Contribution details for the coverage, if applicable. | Small, 65.0 | 65.0 | | coverageId | String | ID of the coverage. | Small, 65.0 | 65.0 | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details. | Small, 65.0 | 65.0 | | proratedRates | [Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.") | Prorated rates for the coverage. | Small, 65.0 | 65.0 | | rates | [Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.") | Rate details for the coverage. | Small, 65.0 | 65.0 | # Insurance Create Quote From Contract Input Input representation of the details to create a quote from an existing group benefits contract. ## JSON Example { "quoteName": "QuoteFromContract1", "eventEffectiveFromDate": "2027-03-20", "groupCensusId": "0rfxx000000000BAAQ", "transactionType": "GroupInsuranceTransactionType", "insuranceQuoteType": "GroupEndorsement", "configOptions": { "executeConfigurationRules": false, "executeQualificationRules": false }, "additionalFields": { "insuranceQuoteItemList": \[ { "entity": "Quote", "fields": { "data": \[ { "key": "StandardAmount", "value": 80 } \] } }, { "entity": "QuoteLineItem", "productPath": "medBasic", "fields": { "data": \[ { "key": "UnitPrice", "value": 900 } \] } }, { "entity": "QuoteLineItem2", "productPath": "medBasic/pcw1", "fields": { "data": \[ { "key": "PlanAllocationType\_\_std", "value": "STANDARD" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Quote Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_item.htm "Input representation of the details to extend the quote created from a contract.")\[\] | List of additional entity field values to apply when creating the quote. | Optional | 68.0 | | censusRatingType | String | Rating type to use for the census when calculating the quote, such as Summary or Member. | Optional | 68.0 | | configOptions | [Insurance Quote Configuration Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_gb_quote_config_options.htm "Input representation of the details to specify whether configuration and qualification rules run when creating a quote from a contract.") | Configuration options that control whether configuration and qualification rules run during quote creation. | Optional | 68.0 | | eventEffectiveFromDate | String | Date that the quote is effective from. | Required | 68.0 | | eventEffectiveToDate | String | Expiration date of the quote. | Required | 68.0 | | groupCensusId | String | ID of the group census that the quote is created for. | Required | 68.0 | | insuranceQuoteType | String | Type of insurance quote to be created from the contract. | Required | 68.0 | | quoteName | String | Name of the quote. | Optional | 68.0 | | ratingDate | String | Date on which the rating of the quote is calculated. | Optional | 68.0 | | transactionType | String | Type of insurance transaction, such as endorsement or renewal. | Required | 68.0 | # Insurance Create Quote From Contract Response Response returned when creating a group benefits quote from an existing contract. ## JSON Example { "message": "Quote created successfully", "isSuccess": true, "quoteId": "0Q0xx0000004C92AAE", "errors": null } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while creating the quote. Shows null when the request succeeds. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the quote is created successfully (true) or not (false). | Small, 68.0 | 68.0 | | message | String | Status message for the quote creation request. | Small, 68.0 | 68.0 | | quoteId | String | ID of the quote created from the contract. | Small, 68.0 | 68.0 | # Insurance Create Underwriting Rules Output representation details of insurance create underwriting rules request. ## JSON Example This example shows a sample success response. { "underwritingRuleGroupId": "u8ixx0000007MnhEAI", "underwritingRuleId": "11Oxx0000007MnhEAE", "apiName": "ExampleApiName", "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the underwriting rule. | Big, 63.0 | 63.0 | | errors | [Insurance Underwriting Rules Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rules_error.htm "Details of the error response.")\[\] | List of errors encountered during the processing of the API request. | Big, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the request is successful (true) or not (false). | Big, 63.0 | 63.0 | | underwritingRuleGroupId | String | ID of the underwriting rule group. | Big, 63.0 | 63.0 | | underwritingRuleId | String | ID of the underwriting rule. | Big, 63.0 | 63.0 | # Insurance Create Underwriting Rules Input Create Underwriting Rule Input Representation ## JSON Example { "name": "Automatically Approve Quote", "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "status": "Draft", "description": "Rule description”, "underwritingRuleGroup": { "underwritingRuleGroupId": "1KQ000000MKJIK", // Optional, // if underwritingRuleGroupId exist, then use it as parent instead of create a new record. "stageTransitionId": "0jjDR00000000VGAAA", // State Transition id. "stageTransitionName": "Draft to Approved", "objectType": "Quote", "recordType": "--Master--", "fromStage": "Draft", "toStage": "Approved", "rootProductId": "01tDR000000EMslYAG" // Auto Gold. "ruleKey": "UW\_\_autoSilver\_\_DraftToApproved\_\_VehicleValueLessThan200K" "criteriaExpression": "1" // Exmple "(1 AND 2) OR 3" if more than 1 rules. } "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "sequence": 1, "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : // Need More details on it. "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : // Need More details on it. "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are optional // Fulfillment plan design time entities will be created. "evaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records { "name": "QuoteApproveSuccessTaskGroup", "tasks": \[ // create FulfillmentStepDefinition records { "name": "KYC check flow", // FulfillmentStepDefinition API Names "type": "AutoTask",// FulfillmentStepDefinition type "flowApiName": "KYC check flow", // Flow API Names } \] }, "evaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup { "name": "QuoteApproveFailureTaskGroup", "tasks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] } } ## Properties
Name Type Description Required or Optional Available Version
apiName String Unique API name of the underwriting rule. Required 63.0
description String Description of the underwriting rule Optional 63.0
effectiveFromDate String Date from which the underwriting rule is effective. Required 63.0
effectiveToDate String Date until which the underwriting rule is effective. Optional 63.0
evaluationFailureTaskGroup Evaluation Task Group Input[] Input details for failed evaluation tasks. Optional 63.0
evaluationSuccessTaskGroup Evaluation Task Group Input[] Input details for successful evaluation tasks. Optional 63.0
name String Name of the underwriting rule Required 63.0
productPath String Name of the product path. Required 63.0
ruleCriteria Insurance Rule Criteria Input[] Rule criteria for the underwriting rule. Required 63.0
ruleKey String Unique key for the variable defined in CML (Constraint Modeling Language) that represents the constraint for the insurance product clause. The format must be `UW__<productCode>__<stageTransitionName>__<ruleApiName>`.

If not specified, the API generates the rule key based on the defined product clause.

 Optional 67.0
status String Status of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
 Optional 63.0
underwritingRuleGroup Insurance Underwriting Rule Group Input[] The UnderwritingRuleGroup input data. Required 63.0
# Insurance Delete Census Member Input Input representation to delete census member. ## JSON Example { "memberIds": \[ "0r6RM0000000h1pYAA" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberIds | String\[\] | IDs of the group census member that must be deleted. | Required | 65.0 | # Insurance Design Advisor Use Insurance Design Advisor to check your product configuration against everything a quote or policy flow needs. The advisor validates selling models, pricebook entries, pricing procedures, attributes, user permissions, context definitions, and more, and then returns structured validation results with step-by-step remediation guidance. Ask in natural language through Agentforce or use your desired MCP client. Validations run independently and you see every issue in a single pass, rather than discovering them one at a time.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions with Digital Insurance and requires access to the Headless 360 MCP Server (Beta).
- **[Insurance Design Advisor Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_business_api_overview.htm)** Use the Insurance Design Advisor Connect APIs at design time to validate product model setup, attributes, pricing configurations, API requests, user permissions, and other related insurance product configurations before using the product at runtime. These APIs only validate the product setup details and don't update any data. To use these APIs, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access. - **[Insurance Design Advisor Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_apex_reference.htm)** Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Design Advsior Apex reference includes built-in Apex classes and interfaces, grouped by namespace. To use these Apex methods, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access. # Insurance Design Advisor Apex Reference Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Design Advsior Apex reference includes built-in Apex classes and interfaces, grouped by namespace. To use these Apex methods, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_connect_api_namespace.htm)** The ConnectApi namespace (also called Connect in Apex) in Insurance Design Advisor provides classes for accessing the same data available in the Insurance Design Advisor Business APIs. # Insurance Design Advisor Business APIs Use the Insurance Design Advisor Connect APIs at design time to validate product model setup, attributes, pricing configurations, API requests, user permissions, and other related insurance product configurations before using the product at runtime. These APIs only validate the product setup details and don't update any data. To use these APIs, the org must have Insurance Design Advisor enabled and users must have Digital Insurance Product Administration Management permission set access.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
This table lists the available Insurance Design Advisor resources. | Resource | Description | | --- | --- | | [/connect/insurance/design-advisor/api-request-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_api_request_validation.htm "Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model.") (POST) | Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model. | | [/connect/insurance/design-advisor/attribute-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_attribute_validation.htm "Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated.") (POST) | Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated. | | [/connect/insurance/design-advisor/cml-model-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_cml_model_validation.htm "Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent.") (POST) | Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records, and return resolution guidance when the CML configuration is incomplete or inconsistent. | | [/connect/insurance/design-advisor/error-code-lookup](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_error_code_lookup.htm "Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions. Use this resource when a product model validation error is encountered during setup and you need contextual troubleshooting guidance.") (POST) | Look up an insurance error code and return its description, root cause, and step-by-step resolution instructions. | | [/connect/insurance/design-advisor/get-rating-input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_get_rating_input.htm "Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API (/connect/insurance/product-rating) after replacing sample values with real data.") (POST) | Generate a sample rating input for the specified insurance product to use as the request body in the Insurance Product Rating API after replacing sample values with real data. | | [/connect/insurance/design-advisor/pricing-setup-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_pricing_setup_validation.htm "Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition.") (POST) | Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. | | [/connect/insurance/design-advisor/product-discovery-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_product_discovery_validation.htm "Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations.") (POST) | Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. | | [/connect/insurance/design-advisor/product-model-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_product_model_validation.htm "Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance.") (POST) | Validate the setup and configuration of insurance product models at design time, including the product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. | | [/connect/insurance/design-advisor/user-permissions-validation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_user_permissions_validation.htm "Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy. If the user isn’t authorized to perform the specified action, the API returns the validation status along with troubleshooting guidance.") (POST) | Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, and return troubleshooting guidance when the user isn’t authorized. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_business_apis_resources.htm)** Learn about the available Insurance Design Advisor API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_business_apis_requests.htm)** Learn about the available Insurance Design Advisor API requests. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_design_advisor_business_apis_responses.htm)** Learn about the response bodies of Insurance Design Advisor API responses. # Insurance Design Advisor Error Details Output representation of one validation diagnostic, including the error code and message. ## JSON Example { "code": "SF-INS-DSAV-00031", "message": "The specified attribute exists but is not active." } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Code that identifies the validation failure. Per-attribute failures use SF-INS-DSAV-00030 when the attribute definition isn’t found, SF-INS-DSAV-00031 when it exists but isn’t active, and SF-INS-DSAV-00032 when the lookup doesn’t include an attribute ID, code, or developer name. | Big, 68.0 | 68.0 | | message | String | Message that describes why the attribute is invalid and how to resolve it. | Big, 68.0 | 68.0 | # Insurance Design Advisor Error Response Output representation of a top-level error returned before per-attribute validation runs. ## JSON Example { "code": "INSUFFICIENT\_ACCESS", "message": "Access denied" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Code that identifies the failure. Examples include SF-INS-DSAV-00032 when the request body is missing or the lookup list is empty, INSUFFICIENT\_ACCESS when the caller lacks access or Digital Insurance isn’t enabled, and INTERNAL\_SERVER\_ERROR for an unexpected failure. | Big, 68.0 | 68.0 | | message | String | Message that describes the failure. | Big, 68.0 | 68.0 | # Insurance Eligible Product Clauses Add (POST) Add selected eligible product clauses to a quote or context. ## Resource /connect/insurance/product-clauses/add-eligible-product-clauses ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-clauses/add-eligible-product-clauses ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000000001AAA", "quoteLineItemId": "0QLxx0000000002BBB", "contextId": "0j5xx0000000003CCC", "instanceKey": \["Auto", "Liability"\], "insuranceProductClauses": \[ { "insuranceProductClauseId": "0j4xx0000000004DDD", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31" } \], "options": { "saveContext": false } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context. | Required if quoteId isn't specified | 65.0 | | instanceKey | String\[\] | List of product instance IDs from the root product to the target quote line item. | Required if quoteLineItemId isn't specified | 65.0 | | insurance​Product​Clauses | [Insurance Product Clause Input\[\]](connect_requests_insurance_product_clause_input.htm "Input representation for a single insurance product clause.") | List of insurance product clauses to add. | Required | 65.0 | | options | [Add Eligible Product Clauses Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_add_eligible_product_clauses_options_input.htm "Input representation for options when adding eligible product clauses.") | Options for adding eligible product clauses. | Optional | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quoteLine​ItemId | String | ID of the quote line item. | Required if instanceKey isn't specified | 65.0 | ## Response Body for POST [Add Eligible Product Clauses Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_add_eligible_product_clauses_output.htm "Output representation for adding eligible product clauses.") # Insurance Eligible Product Clauses Get (POST) Get eligible product clauses based on quoteId and contextId. ## Resource /connect/insurance/product-clauses/eligible-product-clauses ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-clauses/eligible-product-clauses ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "instanceKey": \[ "a3Nxx000000CmikEAC" \], "quoteId": "0Q0xx000000Dm3jCAC", "quoteLineItemId": "0QLxx000000E5d1OAC" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of context. | Required if quoteId isn't specified | 65.0 | | instanceKey | String\[\] | List of product instance IDs from the root product to the target quote line item. | Required if quoteLineItemId isn't specified | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quoteLine​ItemId | String | ID of the quote line item. | Required if instanceKey isn't specified | 65.0 | ## Response Body for POST [Insurance Get Eligible Product Clauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_eligible_clauses_output.htm "Output representation for eligible clauses.") # Insurance Error Output representation for an error that occurred during a census management operation. ## JSON Example { "code": "RESOURCE\_NOT\_FOUND", "message": "The requested resource does not exist", "additionalInfo": { "memberId": "0r6RM0000000h1pYAA" } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalInfo | Map | Map of additional details about the error, such as the ID of the record that caused the failure. | Small, 65.0 | 65.0 | | code | String | Error code. | Small, 65.0 | 65.0 | | message | String | Error message. | Small, 65.0 | 65.0 | # Insurance Generate Census Input Input representation of the details to generate a group census from the policies on an existing group benefits contract. ## JSON Example { "shouldGenerateCSV": true, "shouldIncludeMemberPlans": true, "filter": { "contractGroupPlanIds": { "values": \[ "0rgVW00000001tlYAA" \] }, "objectName": "Contact", "recordIds": { "values": \[ "003VW00000BcBIfYAN" \] } } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusName | String | Name of the group census to create. | Optional | 68.0 | | censusType | String | Type of group census to generate, such as Enrollment or Quote. | Required | 68.0 | | filter | [Insurance Census Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_filter_input.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that indicate which policy records to include when generating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating the group census, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 | | requestId | String | ID of the asynchronous request from a previous run. | Required when you regenerate a group census that failed in the previous run. | 68.0 | | shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with all the census details (true) or not (false). | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include insurance plan details for each member in the generated group census (true) or not (false). | Optional | 68.0 | # Insurance Generate Census Response Output representation of the details when you generate a group census from the policies on an existing group benefits contract. ## JSON Example { "isSuccess": true, "message": "Census generation started successfully", "groupCensusId": "0rfxx0000004C92AAA", "requestId": "08Pxx0000000001EAA", "errors": null } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while generating the group census. Shows null when the request succeeds. | Small, 68.0 | 68.0 | | groupCensusId | String | ID of the group census record that's created from the contract policies. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the group census is created successfully (true) or not (false). | Small, 68.0 | 68.0 | | message | String | Message describing the result of the asynchronous census generation process. | Small, 68.0 | 68.0 | | requestId | String | ID of the asynchronous request that generates the group census for the specified group benefits contract. Use this ID to track the job or to retry a failed run. | Small, 68.0 | 68.0 | # Insurance Generate Refresh Census Members Additional Fields Input Input representation of the additional field values to apply to group census members during a generate or refresh census members operation. ## JSON Example { "members": \[ { "memberId": "0YLxx0000004C92EAG", "fields": \[ { "key": "Status\_\_c", "value": "Active" } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | members | [Insurance Upsert Member Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_upsert_member.htm "Input representation of a group census member and the additional field values to apply during an upsert operation.")\[\] | List of members and their additional field values. | Optional | 68.0 | # Insurance Generate Refresh Census Members Input Input representation of the details to generate or update group census members from policy information on an existing group benefits contract. ## JSON Example { "censusName": "Acme Enrollment Census 2026", "censusType": "Enrollment", "groupCensusId": "0rfxx0000004C92AAA", "policyEffectiveDate": "2026-01-01", "shouldGenerateCsv": true, "shouldIncludeMemberPlans": true, "personAccountIds": \[ "001xx000003DGb2AAG" \], "contactIds": \[ "003xx000004WhKhAAK" \], "policyIds": \[ "0YTxx0000004C92GAE" \], "additionalFields": { "members": \[ { "memberId": "0YLxx0000004C92EAG", "fields": \[ { "key": "Status\_\_c", "value": "Active" } \] } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Generate Refresh Census Members Additional Fields Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_generate_refresh_census_members_additional_fields.htm "Input representation of the additional field values to apply to group census members during a generate or refresh census members operation.") | Additional field values to apply to each group census member during the upsert operation. Use this parameter to set nonstandard fields, such as extended or custom fields. | Optional | 68.0 | | censusName | String | Name for the group census record. | Optional | 68.0 | | censusType | String | Type of census, for example Enrollment or Quote. | Optional | 68.0 | | contactIds | String\[\] | Contact IDs used to extract member information. If you specify contact IDs, you must also specify a policy ID to correctly identify the associated members. | Optional | 68.0 | | groupCensusId | String | ID of the group census. Required when you update existing group census member details. | Optional | 68.0 | | personAccountIds | String\[\] | IDs of the Person Accounts used to identify the members to include when processing the group census. Member information is extracted from the specified accounts. | Optional | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating or updating group census member details, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 | | policyIds | String\[\] | Policy IDs from which member information is retrieved for the specified contacts or accounts. | Optional | 68.0 | | shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census data (true) or not (false). | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members in the processed group census (true) or not (false). If set to true, the group census includes insurance plan details for each member. | Optional | 68.0 | # Insurance Generate Refresh Census Members Response Output representation of the details when you generate or update group census members from policy information on an existing group benefits contract. ## JSON Example { "isSuccess": true, "groupCensusId": "0rfxx0000004C92AAA", "errors": null } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors encountered during the generate or update census members operation. Shows null when the request succeeds. | Small, 68.0 | 68.0 | | groupCensusId | String | ID of the group census whose member details are generated or updated. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Small, 68.0 | 68.0 | # Insurance Get Eligible Clauses Input Input representation for get eligible insurance product clauses. ## JSON Example { "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "instanceKey": \[ "a3Nxx000000CmikEAC" \], "quoteId": "0Q0xx000000Dm3jCAC", "quoteLineItemId": "0QLxx000000E5d1OAC" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of context. | Required if quoteId isn't specified | 65.0 | | instanceKey | String\[\] | List of product instance IDs from the root product to the target quote line item. | Required if quoteLineItemId isn't specified | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quoteLine​ItemId | String | ID of the quote line item. | Required if instanceKey isn't specified | 65.0 | # Insurance Get Eligible Product Clauses Output representation for eligible clauses. ## JSON Example { "errors": \[\], "insuranceProductClauses": \[ { "category": "Manual", "clauseName": "Manual Clause 1", "description": "This is a manually added clause.", "effectiveDate": "2025-10-01T12:00:00.000Z", "expirationDate": "2026-10-01T12:00:00.000Z", "insuranceProductClauseId": "a4Lxx000000Cde1EAC", "type": "Clause" } \], "success": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Product Clause Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_product_clause_error.htm "Output representation of an error that occurred during the product clause operation.")\[\] | List of errors that occurred during the API operation. | Big, 65.0 | 65.0 | | insurance​Product​Clauses | [Insurance Product Clause Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_product_clause.htm "Output representation for insurance product clause.")\[\] | List of insurance product clauses. | Big, 65.0 | 65.0 | | success | Boolean | Indicates whether the operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # Insurance Get Rating Input Input Input representation that specifies the product for which to generate a sample rating input payload. ## JSON Example { "productId": "01txx0000006iPnAAI" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the product for which you want to generate a sample rating API request. Must be a valid 15- or 18-character Salesforce ID. | Required | 68.0 | # Insurance Get Rating Input Response Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails. ## JSON Example { "ratingInput": "{"quoteLineItems":\[{"productCode":"AUTO\_POLICY","instanceKey":"a1b2c3d4-e5f6","attributes":\[{"attributeCode":"DRIVER\_AGE","value":""},{"attributeCode":"VEHICLE\_MAKE","value":""},{"attributeCode":"VEHICLE\_YEAR","value":""}\],"childProducts":\[{"productCode":"COLLISION\_COVERAGE","instanceKey":"f7g8h9i0-j1k2","attributes":\[{"attributeCode":"DEDUCTIBLE\_AMOUNT","value":""}\]},{"productCode":"LIABILITY\_COVERAGE","instanceKey":"l3m4n5o6-p7q8","attributes":\[{"attributeCode":"COVERAGE\_LIMIT","value":""}\]}\]}\],"instanceKeys":\[{"instanceKey":\["a1b2c3d4-e5f6","f7g8h9i0-j1k2","l3m4n5o6-p7q8"\]}\]}", "additionalDetails": "The sample omits transactionType. Supply a TransactionProcessingType developer name configured in the org before you send the payload to the rating API.", "errors": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalDetails | String | Advisory note about using the sample payload. For example, the sample can omit transactionType, which you must supply (a TransactionProcessingType developer name configured in the org) before you send the payload to the rating API; otherwise the quote-level pricing procedure doesn’t resolve. | Big, 68.0 | 68.0 | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | List of errors encountered during rating input generation. Empty or absent when the API operation has no error. Each item provides an error code and a message. | Big, 68.0 | 68.0 | | ratingInput | String | Serialized JSON string containing a complete sample rating request body to use with the insurance/product-rating API. The JSON string includes product hierarchy, product codes, instance keys, and attribute codes with sample values. Parse this string before you submit it to the rating API, and replace sample values with real data. | Big, 68.0 | 68.0 | # Insurance Group Adjustment Input Input representation of the optional flow and repricing settings used to submit a bulk mid-term adjustment request for a group census. The source group census is supplied as the {censusId} path parameter. ## JSON Example { "flowApiName": "Process\_Group\_Census\_Member\_Data", "shouldReprice": true } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowApiName | String | API name of the custom flow to use for bulk member data processing for adjustment operations. If not specified, the default flow is used. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | # Insurance Group Adjustment Response Output representation of the details that are returned after a bulk mid-term adjustment request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. ## JSON Example { "errors": \[\], "requestId": "15U000000000001AAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while validating the request or scheduling the asynchronous adjustment job. | Big, 68.0 | 68.0 | | requestId | String | ID of the asynchronous bulk request. Use this ID to track the status of the mid-term adjustment job. | Big, 68.0 | 68.0 | # Insurance Group Benefits Group benefits are insurance plans offered to and covering a group of people, such as employees and their dependents. Manage these insurance offerings in a rapidly evolving marketplace with Group Benefits on the Digital Insurance Platform.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
- **[Insurance Group Benefits Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_business_api_overview.htm)** Use the Group Benefits API resources to effectively manage the insurance plans offered to groups, such as employees and their dependents. - **[Insurance Group Benefits Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_apex_reference.htm)** Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Group Benefits Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[Insurance Group Benefits Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_invocable_actions_parent.htm)** Use the standard invocable actions available with Insurance Group Benefits to effectively manage the insurance plans offered to groups, such as employees and their dependents. - **[Insurance Group Benefits Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. # Insurance Group Benefits Apex Reference Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Group Benefits Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_connect_api_namespace.htm)** The ConnectApi namespace (also called Connect in Apex) in Insurance Group Benefits provides classes for accessing the same data available in the Insurance Group Benefits Business APIs. # 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. # Insurance Group Benefits Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Group Benefits. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Group Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_group_benefits_flow_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Group Benefits exposes additional actionType values for the FlowActionCall Metadata type. # Insurance Group Benefits Standard Invocable Actions Use the standard invocable actions available with Insurance Group Benefits 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 - **[Census Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_census_management.htm)** Create, update, clone, and map group census members and their plans. - **[Quote Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_quote_management.htm)** Create quotes from existing contracts and apply member-level plan overrides. - **[Financial Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_financial_management.htm)** Rate quotes and members, compare census prices, and generate contract transactions. - **[Contract Lifecycle Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_contract_lifecycle_management.htm)** Issue, endorse, and renew group benefits contracts. - **[Policy Lifecycle Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_policy_lifecycle_management.htm)** Enroll members, apply mid-term adjustments, and renew member policies. # Insurance Group Census Details Output representation of group census summary data. ## JSON Example { "groupCensus": { "id": "a0B1x000000XXXXX", "memberOptOutCount": 5, "mbrWithoutDependentCount": 20, "memberWithOneChildCount": 15, "mbrWithMoreThan1ChldCount": 10, "mbrWithMoreThan2ChldCount": 5, "memberWithDependentCount": 30, "memberWithSpouseCount": 25, "totalMemberPlusDependent": 85, "totalDependents": 45, "totalMembers": 40, "fullTimeMemberCount": 35, "partTimeMemberCount": 5, "grpCensusGrpClassSummaryList": \[ { "id": "a0C1x000000YYYYY", "groupCensusId": "a0B1x000000XXXXX", "groupClassId": "a0D1x000000ZZZZZ", "memberOptOutCount": 2, "mbrWithoutDependentCount": 10, "memberWithOneChildCount": 5, "mbrWithMoreThan1ChldCount": 3, "mbrWithMoreThan2ChldCount": 2, "memberWithDependentCount": 10, "memberWithSpouseCount": 8, "totalMemberPlusDependent": 28, "totalDependents": 15, "totalMembers": 13, "fullTimeMemberCount": 12, "partTimeMemberCount": 1 } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fullTimeMemberCount | Integer | Total number of full-time members. | Small, 65.0 | 65.0 | | grpCensus​GrpClass​SummaryList | [Group Census Group Class Summary](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_grp_census_grp_class_summary_output.htm "Output representation of census summary data aggregated by group class.")\[\] | List of census summaries that are aggregated by group class. | Small, 65.0 | 65.0 | | id | String | ID of the group census summary. | Small, 65.0 | 65.0 | | mbrWith​MoreThan1​ChldCount | Integer | Total number of members who have more than one child dependent. | Small, 65.0 | 65.0 | | mbrWith​MoreThan2​ChldCount | Integer | Total number of members who have more than two child dependents. | Small, 65.0 | 65.0 | | mbrWithout​Dependent​Count | Integer | Total number of members who have no dependents. | Small, 65.0 | 65.0 | | memberOpt​OutCount | Integer | Total number of members who have opted out of all insurance plans. | Small, 65.0 | 65.0 | | memberWith​DependentCount | Integer | Total number of members who have at least one dependent of any type. | Small, 65.0 | 65.0 | | memberWith​OneChildCount | Integer | Total number of members who have exactly one child dependent. | Small, 65.0 | 65.0 | | memberWith​SpouseCount | Integer | Total number of members who have a spouse listed as a dependent. | Small, 65.0 | 65.0 | | partTime​MemberCount | Integer | Total number of part-time members. | Small, 65.0 | 65.0 | | totalDependents | Integer | Total of all dependent records across all members in the census. | Small, 65.0 | 65.0 | | totalMember​PlusDependent | Integer | Total of all members and all their dependents. | Small, 65.0 | 65.0 | | total​Members | Integer | Total number of primary members in the census. | Small, 65.0 | 65.0 | # Insurance Group Census Member Management Output representation for the details of the group census members. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that are associated with the API operation. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Small, 65.0 | 65.0 | | memberIds | String\[\] | List of IDs for the group census members that are created, updated, or deleted. | Small, 65.0 | 65.0 | # Insurance Group Census Member Management Input Input representation for the details to add or update group census members. ## JSON Example { "members": { "values": \[ { "name": "member1", "firstName": "fm", "lastname": "lm", "email": "cci@test.com", "sourceSystemIdentifier": "1.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "member2", "firstName": "fm2", "lastname": "lm2", "email": "cci@test.com", "sourceSystemIdentifier": "2.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "dep1", "firstName": "depfm", "lastname": "depfm", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "1.Child", "primaryMemberSource": "1.primary" }, { "name": "dep2", "firstName": "depfm2", "lastname": "depfm2", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "2.Child", "primaryMemberSource": "2.primary" } \] }, "duplicateDetectionFields": { "values": \[ "firstName" \] } } ## Properties
Name Type Description Required or Optional Available Version
duplicate​Detection​Fields String[] List of field API names that are used to generate a unique key for identifying duplicate members along with default values.

The default fields for duplicate detection are FirstName, LastName, AssociationWithPrimaryMbr, and GroupCensusId.

Optional 65.0
flowName String Name of the flow to use for processing group member data.

Default value is Process Group Census Member Data.

 Optional 65.0
members Group Census Member Input[] List of group census members to add or update. Required 65.0
# Insurance Group Census Members (POST, PATCH, DELETE) Add (POST) and update (PATCH) group census members. Delete all census members for the specified group census ID. ## Resource {groupCensusId} is a placeholder. /connect/insurance/census-management/group-censuses/{groupCensusId}/group-census-members ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-censuses/0rlxx000000001aEAA/group-census-members ## Available Version 65.0 ## HTTP Methods POST, PATCH, DELETE ## Path Parameter for POST, PATCH, and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusId | String | ID of the group census. | Required | 65.0 | ## Request Body for POST ### JSON Example { "members": { "values": \[ { "name": "member1", "firstName": "fm", "lastname": "lm", "email": "cci@test.com", "sourceSystemIdentifier": "1.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "member2", "firstName": "fm2", "lastname": "lm2", "email": "cci@test.com", "sourceSystemIdentifier": "2.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "dep1", "firstName": "depfm", "lastname": "depfm", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "1.Child", "primaryMemberSource": "1.primary" }, { "name": "dep2", "firstName": "depfm2", "lastname": "depfm2", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "2.Child", "primaryMemberSource": "2.primary" } \] }, "duplicateDetectionFields": { "values": \[ "firstName" \] } } ### Properties
Name Type Description Required or Optional Available Version
duplicate​Detection​Fields String[] List of field API names that are used to generate a unique key for identifying duplicate members along with default values.

The default fields for duplicate detection are FirstName, LastName, AssociationWithPrimaryMbr, and GroupCensusId.

Optional 65.0
flowName String Name of the flow to use for processing group member data.

Default value is Process Group Census Member Data.

 Optional 65.0
members Group Census Member Input[] List of group census members to add or update. Required 65.0
## Response Body for POST [Insurance Group Census Member Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_mgmt_output.htm "Output representation for the details of the group census members.") ## Request Body for PATCH ### JSON Example { "members": { "values": \[ { "name": "member1", "firstName": "fm", "lastname": "lm", "email": "cci@test.com", "sourceSystemIdentifier": "1.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "member2", "firstName": "fm2", "lastname": "lm2", "email": "cci@test.com", "sourceSystemIdentifier": "2.primary", "primaryMemberSource": null, "relationshipToPrimaryMember": "Self", "associationWithPrimaryMbr": "Self" }, { "name": "dep1", "firstName": "depfm", "lastname": "depfm", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "1.Child", "primaryMemberSource": "1.primary" }, { "name": "dep2", "firstName": "depfm2", "lastname": "depfm2", "email": "cci@test.com", "associationWithPrimaryMbr": "Child", "relationshipToPrimaryMember": "Child", "sourceSystemIdentifier": "2.Child", "primaryMemberSource": "2.primary" } \] }, "duplicateDetectionFields": { "values": \[ "firstName" \] } } ### Properties
Name Type Description Required or Optional Available Version
duplicate​Detection​Fields String[] List of field API names that are used to generate a unique key for identifying duplicate members along with default values.

The default fields for duplicate detection are FirstName, LastName, AssociationWithPrimaryMbr, and GroupCensusId.

Optional 65.0
flowName String Name of the flow to use for processing group member data.

Default value is Process Group Census Member Data.

 Optional 65.0
members Group Census Member Input[] List of group census members to add or update. Required 65.0
## Response Body for PATCH [Insurance Group Census Member Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_mgmt_output.htm "Output representation for the details of the group census members.") ## Response Body for DELETE [Insurance Group Census Member Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_mgmt_output.htm "Output representation for the details of the group census members.") # Insurance Group Census Members Delete (POST) Delete one or more census members of the specified group census ID. ## Resource {groupCensusId} is a placeholder. /connect/insurance/census-management/group-censuses/{groupCensusId}/group-census-members/delete ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-censuses/0rlxx000000001aEAA/group-census-members/delete ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusId | String | ID of the group census. | Required | 65.0 | ## Request Body for POST ### JSON Example { "memberIds": \[ "0r6RM0000000h1pYAA" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberIds | String\[\] | IDs of the group census member that must be deleted. | Required | 65.0 | ## Response Body for POST [Insurance Group Census Member Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_mgmt_output.htm "Output representation for the details of the group census members.") # Insurance Group Endorsement Input Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census. ## JSON Example { "flowName": "ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy", "shouldReprice": true } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to run to update member policies. The default value is the API name of the Apply Contract Adjustments to Member Policies flow: ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | # Insurance Group Endorsement Response Output representation of the details that are returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. ## JSON Example { "errors": \[\], "requestId": "0jKSG0000000abc1AA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors with a message and an error code that occurred while validating the request or scheduling the asynchronous job. | Big, 68.0 | 68.0 | | requestId | String | ID of the asynchronous job request that updates member policies. Use this ID to track the status of the job. | Big, 68.0 | 68.0 | # Insurance Group Plan Input Input representation for group census member plans and their coverages. ## JSON Example { "plans": { "values": \[ { "planId": "8ckxx000000000001", "attributes": { "values": \[ { "attributeCode": "AGE\_BAND", "attributeValue": "18-25" } \] }, "coverages": { "values": \[ { "planId": "8ckxx000000000002", "attributes": { "values": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Employee Only" } \] } }, { "productCode": "01txx000000000001" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_attribute_input.htm "Input representation of an overridden attribute value on a group census member plan.") \[\] | Attributes for this plan or coverage. These values override plan-level default attribute values before they are sent to the [Salesforce CPQ](https://www.salesforce.com/in/sales/cpq/what-is-cpq/) configurator for rule evaluation. | Optional | 68.0 | | coverages | [Insurance Group Plan Input](# "Input representation for group census member plans and their coverages.")\[\] | List of coverages that are associated with this plan. | Optional | 65.0 | | planId | String | ID of the contract group plan or coverage. | Required | 65.0 | | productCode | String | Insurance product code used for coverages when contract group plan ID isn't available. This parameter is valid only within the coverages property. | Optional | 68.0 | # Insurance Group Plan UI Treatment Output representation of a UI treatment returned by the configurator for a plan or coverage. ## JSON Example {"uiTreatments": \[ { "details": { "attributeId": "0tjxx000000000cAAA", "attributeCode": "onmedFees", "stiId": "ref\_875915aa\_61c4\_4916\_ae58\_9fa7e0dec529", "attributeName": "Out-Network ICU Fees" }, "uiTreatmentTarget": "attribute", "uiTreatmentType": "hide" } \]} | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | details | Map | UI treatment details in key-value pairs, including keys, such as planId, productId, prcId, attributeCode, and attributeValue. | Small, 68.0 | 68.0 | | uiTreatmentTarget | String | UI treatment target, such as product, attribute, component, quantity, and attribute\_picklist\_value. | Small, 68.0 | 68.0 | | uiTreatmentType | String | Type of UI actions to be performed on the records, such as hide and disable. | Small, 68.0 | 68.0 | # Insurance Group Plans Output representation of an insurance group plan. ## JSON Example { "isOptional": false, "productCategory": "Medical", "planName": "plan123", "attributes": \[\], "coverages": \[ { "planId": "8ckxx000000000002", "planName": "Dental Coverage", "productCategory": "Dental", "isOptional": true, "attributes": \[\], "uiTreatments": \[ { "uiTreatmentType": "disable", "uiTreatmentTarget": "attribute\_picklist\_value", "details": { "planId": "8ckxx000000000002", "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "0", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceZero", "attributePicklistValueId": "0v6xx000000000SAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "10", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceTen", "attributePicklistValueId": "0v6xx000000000TAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" } \] } \], "uiTreatments": \[ { "details": { "attributeId": "0tjxx000000000cAAA", "attributeCode": "onmedFees", "stiId": "ref\_875915aa\_61c4\_4916\_ae58\_9fa7e0dec529", "attributeName": "Out-Network ICU Fees" }, "uiTreatmentTarget": "attribute", "uiTreatmentType": "hide" } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | [Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.")\[\] | List of attributes that are associated with the contract group plan. | Small, 66.0 | 66.0 | | coverages | [Insurance Group Plans](# "Output representation of an insurance group plan.")\[\] | List of coverages that are associated with this plan. | Small, 66.0 | 66.0 | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | Errors for this plan or coverage returned by the configurator. | Small, 68.0 | 68.0 | | isOptional | Boolean | Indicates whether the plan is optional (true) or not (false). | Small, 66.0 | 66.0 | | planId | String | ID of the contract group plan. | Small, 66.0 | 66.0 | | planName | String | Name of the contract group plan. | Small, 66.0 | 66.0 | | productCategory | String | Category of the contract group plan. | Small, 66.0 | 66.0 | | productCode | String | Product code of the Product2 record for the off-contract coverage overrides. Use this parameter to add a coverage that doesn’t exist in the member’s assigned contract group plan. | Small, 68.0 | 68.0 | | uiTreatments | [Insurance Group Plan UI Treatment \[\]](connect_responses_insurance_group_plan_ui_treatment_output.htm "Output representation of a UI treatment returned by the configurator for a plan or coverage.") | UI treatments for this plan or coverage returned by the configurator. | Small, 68.0 | 68.0 | # Insurance Group Rating (POST) 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. ## Resource {quoteId} is a placeholder. /connect/insurance/quotes/{quoteId}/group-rating ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes/0Q08d0000004sQzCAI/group-rating ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | quoteId | String | ID of the group benefits quote. | Required | 65.0 | ## Request Body for POST ### JSON Example { "batchSize": 200, "quoteLineItemIds": \[ "0qvp00000004C9wAAE" \], "ratingDate": "2025-01-01" } ### Properties
Name Type Description Required or Optional Available Version
batchSize Integer Number of records to process in each batch for the rating calculation.

The default value is 5.

 Optional 65.0
quoteLineItemIds String[] List of quote line item IDs of the root plan. Optional 65.0
ratingDate String Date to use for the rating calculation. If not specified, the API uses the effective date of the quote. Optional 65.0
## Response Body for POST [Group Rating Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_rating_output.htm "Output representation of the Group Benefits Group Rating process.") # Insurance Group Renewal Input Input representation of the optional flow and repricing settings used to renew member policies for a group census. ## JSON Example { "flowName": "RenewMemberPolicies", "shouldReprice": true } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to use for member-policy renewal. If not specified, the default RenewMemberPolicies flow is used. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | # Insurance Group Renewal Response Output representation of the details that are returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. ## JSON Example { "errors": \[\], "requestId": "0jKSG0000000abc1AA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while validating the request or scheduling the asynchronous renewal job. | Big, 68.0 | 68.0 | | requestId | String | ID of the asynchronous bulk request to renew member policies of a group census. Use this ID to track the status of the job. | Big, 68.0 | 68.0 | # Insurance Invoke Underwriting Rule Output representation for invoke underwriting rule response. ## JSON Example This example shows a sample success response. { "objectId": "0Q0SM0000001uL70AI", "objectName": "Quote", "stageTransitionName": "Draft To Submitted", "fromStage": "Draft", "toStage": "Submitted", "stageTransitionUnderwritingEvaluationId": "1MjSG000000LCe50AG", "isSuccess": false, "ruleSetResult": \[ { "productId": "01tSM000005OFyGYAW", "evaluationCriteria": "1 OR 2", "isSuccess": false, "ruleResult": \[ { "evaluationFailureTaskGroup": "13oSG0000005odiYAA", "evaluationSuccessTaskGroup": "13oSG0000005odhYAA", "isSuccess": true, "lineItemDetails": \[ { "id": "0QLSG0000025JvK4AU", "productId": "01tSG000008KnvAYAS", "productInstanceIdentifier": "AutoSilver" } \], "lineItemIds": \[ "0QLSG0000025JvK4AU" \], "ruleApiName": "AutoSilverRoot" }, { "evaluationFailureTaskGroup": "13oSG0000005ofKYAQ", "evaluationSuccessTaskGroup": "13oSG0000005ofJYAQ", "isSuccess": false, "lineItemDetails": \[\], "lineItemIds": \[\], "ruleApiName": "AutoYearGT2020" } \] } \] }
Property Name Type Description Filter Group and Version Available Version
errors Error Response List of errors encountered during the processing of the API request. Small, 63.0 63.0
fromStage String The from stage. Small, 63.0 63.0
isSuccess Boolean Indicates whether the API request is successful ( true) or not ( false).

This parameter is set to true when all individual rule set results are successful.

 Small, 63.0 63.0
objectId String ID of the quote or insurance policy. Small, 63.0 63.0
objectName String Name of the object (Quote or Insurance Policy). Small, 63.0 63.0
ruleSetResult Insurance Underwriting Rule Set Results [] List of underwriting rule set evaluation results. Small, 66.0 66.0
stageTransition​Name String ID of the stage transition. Small, 63.0 63.0
stageTransition​Underwriting​EvaluationId String ID of the underwriting rule evaluation. Small, 63.0 63.0
toStage String The to stage. Small, 63.0 63.0
# Insurance Invoke Underwriting Rule (POST) Invoke underwriting rules for different object records during run time. ## Resource /connect/insurance/underwriting-rules/invoke ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/underwriting-rules/invoke ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "objectId": "11Oxx0000007MnhEAE", "toStage": "Approved" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | objectId | String | ID of the insurance object(Quote or Insurance Policy ID). | Required | 63.0 | | toStage | String | Name of the stage the record is moving to. | Required | 63.0 | ## Response Body for POST [Insurance Invoke Underwriting Rule](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_invoke_underwriting_rule_output.htm "Output representation for invoke underwriting rule response.") # Insurance Invoke Underwriting Rule Input Input representation for invoke underwriting rule operation. ## JSON Example { "objectId": "11Oxx0000007MnhEAE", "toStage": "Approved" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | objectId | String | ID of the insurance object(Quote or Insurance Policy ID). | Required | 63.0 | | toStage | String | Name of the stage the record is moving to. | Required | 63.0 | # Insurance Invoke Underwriting Rule Set Result Output representation for invoke underwriting rule set result response. ## JSON Example This example shows a sample success response. { "ruleSetResult": \[ { "productId": "01tSM000005OFyGYAW", "evaluationCriteria": "1 OR 2", "isSuccess": false, "ruleResult": \[ { "evaluationFailureTaskGroup": "13oSG0000005odiYAA", "evaluationSuccessTaskGroup": "13oSG0000005odhYAA", "isSuccess": true, "lineItemDetails": \[ { "id": "0QLSG0000025JvK4AU", "productId": "01tSG000008KnvAYAS", "productInstanceIdentifier": "AutoSilver" } \], "lineItemIds": \[ "0QLSG0000025JvK4AU" \], "ruleApiName": "AutoSilverRoot" }, { "evaluationFailureTaskGroup": "13oSG0000005ofKYAQ", "evaluationSuccessTaskGroup": "13oSG0000005ofJYAQ", "isSuccess": false, "lineItemDetails": \[\], "lineItemIds": \[\], "ruleApiName": "AutoYearGT2020" } \] } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the product that's evaluated by the rule set. | Small, 66.0 | 66.0 | | evaluationCriteria | String | Evaluation criteria expression that's used during the rule set evaluation. | Small, 66.0 | 66.0 | | ruleResult | [Insurance Underwriting Rule Results](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rule_result_output.htm "Underwriting rule evaluation result.")\[\] | List of underwriting rule evaluation results. | Small, 66.0 | 66.0 | | isSuccess | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Small, 66.0 | 66.0 | # Insurance Issue Contract Input Input representation of the details, such as the quote ID, contract dates, enrollment window, and optional term and additional fields to use to synchronously issue a group benefits contract from a quote. ## JSON Example { "quoteId": "0Q0xx0000004C9OCAU", "contractStartDate": "2026-01-11", "contractEndDate": "2028-01-20", "transactionDetailLevel": "COVERAGE\_LEVEL", "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to add to contract items. | Optional | 68.0 | | contractEndDate | String | End date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract end date that’s derived from the quote. | Required | 68.0 | | contractStartDate | String | Start date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract start date that’s derived from the quote. | Required | 68.0 | | contractTerm | Integer | Duration of the contract in months. If specified, this value overrides the contract term derived from the quote. | Optional | 68.0 | | quoteId | String | ID of the quote from which you want to issue the contract. | Required | 68.0 | | transactionDetailLevel | String | Level of transaction detail to include when issuing the contract. Valid values are: PLAN\_LEVEL, COVERAGE\_LEVEL, CHARGE\_LEVEL. The default value is PLAN\_LEVEL. | Optional | 68.0 | # Insurance Line Item Details Output representation of the enriched line item details for an underwriting rule result. ## JSON Example { "customProductName": "Premier Health Plan", "id": "0YT8M0000004C9YAY", "productId": "01t8M0000001VpYQAI", "productInstanceIdentifier": "PH-99201" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | customProductName | String | Custom name that's assigned to the product within the insurance policy context. | Small, 67.0 | 67.0 | | id | String | ID of the insurance policy line item record. | Small, 67.0 | 67.0 | | productId | String | ID of the associated Product2 record. | Small, 67.0 | 67.0 | | productInstanceIdentifier | String | Unique identifier for the specific instance of the product that's used in the transaction. | Small, 67.0 | 67.0 | # Insurance Lookup Error Code Input Input representation that specifies the insurance error code to look up. ## JSON Example { "errorCode": "SF-INS-DSAV-00023" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | The unique alphanumeric insurance error code identifier to look up. Must follow the SF-INS-XXX-NNNNN format, for example, SF-INS-DSAV-00023 and SF-INS-COM-00009. | Required | 68.0 | # Insurance Lookup Error Code Response Response representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors. ## JSON Example { "errorCode": "SF-INS-DSAV-00023", "errorDescription": "The product code is already in use by another product. Use a unique product code.", "errorCause": null, "instructions": "Assign a unique product code to this product. Navigate to the product record and update the ProductCode field to a value that is not used by any other product in the catalog.", "errors": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCause | String | Detailed explanation of the underlying business logic or validation rule that triggered this error. This field is omitted if a cause is unavailable or null. | Big, 68.0 | 68.0 | | errorCode | String | Error code that’s looked up. | Big, 68.0 | 68.0 | | errorDescription | String | Human-readable description of the error. For known error codes, this is the registered description. It shows an informative “not found” message if the error code is unrecognized. | Big, 68.0 | 68.0 | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | List of request-level validation or processing errors encountered before executing business logic. This list is only shown when the request fails basic validation (such as a missing or blank errorCode). On a successful request, this list is empty. | Big, 68.0 | 68.0 | | instructions | String | Step-by-step troubleshooting guidance to resolve the error. For known codes with an instructions section, this is the localized instruction text. For unknown codes, this property provides format guidance. | Big, 68.0 | 68.0 | # Insurance Member Account and User Details Output representation of a member's person account and portal user details that are created. ## JSON Example { "groupCensusId": "0rfAbcDefGhiJklMno", "groupCensusMemberId": "0r6PrimaryMemberId", "personAccountId": "003abc123DEF456ghi", "userId": "005jkl789MNO012pqr" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | groupCensusId | String | ID of the group census for the specific member. | Small, 65.0 | 65.0 | | groupCensus​MemberId | String | ID of the source group census member who's processed. | Small, 65.0 | 65.0 | | person​AccountId | String | ID of the person account that's created. | Small, 65.0 | 65.0 | | userId | String | ID of the portal user that's created. This property is null if portal user creation isn't requested. | Small, 65.0 | 65.0 | # Insurance Member Contact and User Details Output representation of a member's contact and portal user details that's created. ## JSON Example { "contactId": "003abc123DEF456ghi", "groupCensusId": "0rfAbcDefGhiJklMno", "groupCensusMemberId": "0r6PrimaryMemberId", "userId": "005jkl789MNO012pqr" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contactId | String | ID of the contact record that's created. | Small, 65.0 | 65.0 | | groupCensusId | String | ID of the group census for the specific member. | Small, 65.0 | 65.0 | | groupCensus​MemberId | String | ID of the group census member who's processed. | Small, 65.0 | 65.0 | | userId | String | ID of the portal user that's created. | Small, 65.0 | 65.0 | # Insurance Member Eligible Plans (GET) Get the contract group plans for which a group census member and their dependents are eligible. ## Resource {memberId} is a placeholder. /connect/insurance/census-management/group-census-members/{memberId}/eligible-plans ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-census-members/0r6RM0000000h1pYAA/eligible-plans ## Available Version 65.0 ## HTTP Methods GET ## Path Parameter for GET | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member. | Required | 65.0 | ## Request Parameter for GET
Parameter Name Type Description Required or Optional Available Version
shouldInclude​Dependents Boolean Indicates whether to include the eligible plans for the member's dependents in the response (true) or not (false).

The default value is false.

 Optional 65.0
## Response Body for GET [Insurance Member Eligible Plans Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_members_plans.htm "Output representation for a member's eligible plans.") # Insurance Member Eligible Plans Response Output representation for a member's eligible plans. ## JSON Example This is a sample JSON for a successful API reqest. { "memberId": "0r6xx0000000001AAA", "membersPlansDetails": { "values": \[ { "memberId": "0r6xx0000000001AAA", "plans": { "Medical": { "values": \[ { "attributes": \[\], "coverages": \[ { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx000000001dAAA", "planName": "Annual Health Checkups" }, { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx000000003FAAQ", "planName": "OPD Consults" } \], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx0000000001AAA", "planName": "Bajaj Medical Premium" } \] } } }, { "memberId": "0r6xx0000000002AAB", "plans": { "Medical": { "values": \[ { "attributes": \[\], "coverages": \[ { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx000000001dAAA", "planName": "Annual Health Checkups" } \], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx0000000001AAA", "planName": "Bajaj Medical Premium" } \] } } } \] } } This is a sample JSON with error. { "memberId": "0r6xx0000000001AAA", "membersPlansDetails": { "values": \[ { "error": { "additionalInfo": {}, "code": "SF-0001-0005", "message": "Specify a valid input for memberId." }, "memberId": "0r6xx0000000001AAA", "plans": {} } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID for the primary group census member. | Small, 65.0 | 65.0 | | membersPlans​Details | [Members Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_members_plans_details_list.htm "Output representation for a list of members with their eligible plans.") | List of members with their eligible plans or errors. | Small, 65.0 | 65.0 | # Insurance Member Plans Output representation of the Insurance Get Member Plans service for an individual member. ## JSON Example { "error": null, "memberId": "0r6xx0000000001AAA", "plans": { "Medical": { "values": \[ { "attributes": \[\], "coverages": \[ { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx000000001dAAA", "planName": "Annual Health Checkups" }, { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx000000003FAAQ", "planName": "OPD Consults" } \], "isOptional": false, "isPrimarySubscribed": false, "isSubscribed": false, "planId": "0rgxx0000000001AAA", "planName": "Bajaj Medical Premium" } \] } } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details if an error occurred while getting plans for the member. | Small, 65.0 | 65.0 | | memberId | String | ID of the group census member. | Small, 65.0 | 65.0 | | plans | Map | Map of eligible plans, where the key is the plan category, such as Medical and Dental, and the value is a list of plans in that category. | Small, 65.0 | 65.0 | # Insurance Member Plans (POST, PATCH) Create and update insurance plans for a group census member. ## Resource {memberId} is a placeholder. /connect/insurance/census-management/group-census-members/{memberId}/plans ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-census-members/0r6RM0000000h1pYAA/plans ## Available Version 65.0 ## HTTP Methods POST, PATCH ## Path Parameter for POST and PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member for whom insurance plans must be created or updated. | Required | 65.0 | ## Request Body for POST ### JSON Example { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "contractGroupPlanId": "0rgSG0000000eALYAY" } \] } } This is a sample example to add off-contract coverages. { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "productCode": "01tSG0000000abcDEF", "rootProductCode": "0rgSG0000000e8jYAA" } \] } } This is a sample example to add off-contract coverages with the attribute-level changes. { "groupCensusMemberPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA", "attributes": { "values": \[ { "attributeCode": "code", "attributeValue": "25" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | groupCensusMemberPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of plans to add to the member. | Required | 65.0 | ## Response Body for POST [Insurance Add Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_add_member_plans_output.htm "Output representation for the add member plans operation.") ## Request Body for PATCH ### JSON Example { "addedPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "contractGroupPlanId": "0rgSG0000000eALYAY" } \] }, "upsertedPlans": { "contractGroupPlanId": "0rgxx00000000OEAAY", "attributes": { "values": \[ { "attributeCode": "Deductible", "attributeValue": "0" } \] } }, "deletedPlans": { "values": \[ "0rgSG0000000eALYAY", "0rgSG0000000e8jYAA" \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of plans to add to the member. | Optional | 65.0 | | deletedPlans | String\[\] | List of group census member plan IDs to delete. | Optional | 65.0 | | upsertedPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of existing member plans to update or add if they don't exist, including attribute-level changes to plans the member already has. | Optional | 65.0 | ## Response Body for PATCH [Insurance Update Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_member_plans_output.htm "Output representation for the update member plans operation.") # Insurance Member Plans Delete (POST) Delete specified plans for a group census member. ## Resource {memberId} is a placeholder. /connect/insurance/census-management/group-census-members/{memberId}/plans/action/delete ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-census-members/0r6RM0000000h1pYAA/plans/action/delete ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member for whom insurance plans must be deleted. | Required | 65.0 | ## Request Body for POST ### JSON Example { "plans": { "values": \[ "0rgSG0000000eALYAY", "0rgSG0000000e8jYAA" \] } } ### Properties
Name Type Description Required or Optional Available Version
plans String[] List of group census member plan IDs to delete.

If you specify the root plan ID, all the associated details will be deleted.

 Required 65.0
## Response Body for POST [Delete Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_delete_member_plans_output.htm "Output representation for the member plan deletion process.") # Insurance Member Rating Output representation of the rating for individual members. ## JSON Example { "errors": \[\], "id": "c639a6ec-11d1-4c66-b997-3fff967f052d", "pricingResults": \[ { "errors": \[\], "memberId": "0r6DR0000002UmvYAE", "plans": \[ { "contributions": { "employeePremiumAmount": 51.04, "employerPremiumAmount": 5.67, "errors": \[\] }, "coverages": \[ { "contributions": { "employeePremiumAmount": 51.04, "employerPremiumAmount": 5.67, "errors": \[\], "groupClassContributionId": "0rFDR00000002DM2AY" }, "coverageId": "0rgDR0000001iVPYAY", "errors": \[\], "proratedRates": { "data": { "NetUnitPrice": 56.71, "NetTotalPrice": 56.71, "StandardQLITaxAmount": 0 } }, "rates": { "data": { "NetUnitPrice": 112.5, "NetTotalPrice": 112.5, "StandardQLITaxAmount": 0 } } } \], "errors": \[\], "id": "0rgDR0000001iVLYAY", "proratedRates": { "data": { "NetUnitPrice": 56.71, "NetTotalPrice": 56.71, "StandardQLITaxAmount": 0 } }, "rates": { "data": { "NetUnitPrice": 112.5, "NetTotalPrice": 112.5, "StandardQLITaxAmount": 0 } } } \] } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details. | Small, 65.0 | 65.0 | | id | String | Unique ID that's generated during the member rating transaction. | Small, 65.0 | 65.0 | | pricingResults | [Insurance Member Rating Details\[\]](connect_responses_insurance_member_rating_details_output.htm "Output representation of an individual member's rating results.") | Details of pricing results for a member's rating calculation. | Small, 65.0 | 65.0 | # Insurance Member Rating (POST) Calculate pricing along with employee and employer contribution for individual members of a group census based on plan and coverages within the plan. The prices and contribution are calculated at coverage level and then rolled up to plan and member level. ## Special Access Rule To use this API, the org must be enabled with Person Account and you must have Census Management user access. ## Resource {memberId} is a placeholder. /connect/insurance/group-census-members/{memberId}/action/rate ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-census-members/0r6RM0000000h1pYAA/action/rate ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the primary group census member for which the rating must be calculated. | Required | 65.0 | ## Request Body for POST ### JSON Example { "effectiveDate": "2025-10-01", "members": \[ { "memberId": "0r6RM0000000h1pYAA", "plans": \[ { "planId": "0j5RM00000000a1YAA", "planCoverageIds": \[ "0k8RM00000001b2ZAA" \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the member's rating is calculated. | Optional | 65.0 | | members | [Insurance Member Rating Details Input\[\]](connect_requests_insurance_member_rating_details_input.htm "Input representation for an individual member to be rated.") | Details of the members and their plans to be rated. | Required | 65.0 | ## Response Body for POST [Insurance Member Rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_member_rating_output.htm "Output representation of the rating for individual members.") # Insurance Member Rating Details Output representation of an individual member's rating results. ## JSON Example { "memberId": "0r6PrimaryMemberId", "plans": \[ { "id": "0kfMedicalPlanId01", "rates": { "data": { "total": 350 } }, "proratedRates": { "data": { "total": 350 } }, "contributions": { "employeePremiumAmount": 100, "employerPremiumAmount": 250, "groupClassContributionId": "gcc-001-a", "errors": \[\] }, "coverages": \[ { "coverageId": "cov-hosp-01", "rates": { "data": { "total": 350 } }, "proratedRates": { "data": { "total": 350 } }, "contributions": { "employeePremiumAmount": 100, "employerPremiumAmount": 250, "groupClassContributionId": "gcc-001-a", "errors": \[\] } } \], "errors": \[\] } \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details. | Small, 65.0 | 65.0 | | memberId | String | ID of the member whose rating is calculated. | Small, 65.0 | 65.0 | | plans | [Insurance Plan Rating\[\]](connect_responses_insurance_plan_rating_output.htm "Output representation of an individual plan's pricing result.") | Rating details for the plan. | Small, 65.0 | 65.0 | # Insurance Member Rating Details Input Input representation for an individual member to be rated. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the member. | Required | 65.0 | | plans | [Insurance Member Rating Plans Input\[\]](connect_requests_insurance_member_rating_plans_input.htm "Input representation for an individual rating plan.") | Plan details for individual rating. | Required | 65.0 | # Insurance Member Rating Input Input representation for rating the individual members within a group. ## JSON Example { "effectiveDate": "2025-10-01", "members": \[ { "memberId": "0r6RM0000000h1pYAA", "plans": \[ { "planId": "0j5RM00000000a1YAA", "planCoverageIds": \[ "0k8RM00000001b2ZAA" \] } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date on which the member's rating is calculated. | Optional | 65.0 | | members | [Insurance Member Rating Details Input\[\]](connect_requests_insurance_member_rating_details_input.htm "Input representation for an individual member to be rated.") | Details of the members and their plans to be rated. | Required | 65.0 | # Insurance Member Rating Plans Input Input representation for an individual rating plan. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | planCoverageIds | String\[\] | Coverage IDs within the plan. | Optional | 65.0 | | planId | String | ID of the plan. | Required | 65.0 | # Insurance Message Output Output representation of an insurance message, which can be informational or an error. ## JSON Example { "message": "Plan is eligible for this member.", "type": "Info" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | Content of the message. | Small, 65.0 | 65.0 | | type | String | Type of message, such as Info or Error. | Small, 65.0 | 65.0 | # Insurance Object Map Output representation for a map of attributes with string keys and object values. ## JSON Example { "data": { "attributeKey": "attributeValue" } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | data | Map | Map of string keys and object values. | Small, 65.0 | 65.0 | # Insurance Person Accounts and Users (POST) 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. After the records are created and required permission sets are assigned, members can log into the customer community portal to select plans and complete their individual enrollment based on the digital workflow that's configured by the carrier. ## Special Access Rule To use this API, the org must be enabled with Person Account and you must have Census Management user access. ## Resource /connect/insurance/accounts ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/accounts?createPortalUsers=false ## Available Version 65.0 ## HTTP Methods POST #### See Also - [_Salesforce Help_: Configure Group Benefits Enrollment](https://help.salesforce.com/s/articleView?id=ind.insurance_group_benefits_core_enrollment_configure_intro.htm&language=en_US "Salesforce Help: Configure Group Benefits Enrollment - HTML (New Window)") ## Request Parameters for POST
Parameter Name Type Description Required or Optional Available Version
createPortalUsers Boolean Indicates whether to create portal users for the new person accounts (true) or not (false).

The default value is true.

 Optional 65.0
## Request Body for POST ### JSON Example This is a sample JSON example with GroupCensusId. { "groupCensusId": "0rfxx0000000007AAA", "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } This is a sample JSON example with GroupCensusMembers. { "groupCensusMemberIdList": { "values": \[ "0r6xx0000000002AAA", "0r6xx000000004rAAA" \] }, "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } ### Properties
Name Type Description Required or Optional Available Version
fieldMappings Map<String, String> Map of field API names from the Group Census Member object (key) to the Account object (value). Optional 65.0
groupCensusId String ID of the group census that contains the members to process. Optional 65.0
groupCensusMember​IdList String[] IDs of the group census members for whom you want to create person accounts and users.

If not provided, all members of the specified group census are processed.

 Optional 65.0
matchingKeyList String[] List of field API names on the Group Census Member object that are used to identify and prevent the creation of duplicate person accounts.

The default fields are FirstName, LastName, PersonBirthdate, PersonEmail, and PersonGender.

 Optional 65.0
personAccount​RecordType String Developer name of the person account record type to use for the new accounts. Optional 65.0
userDetails Portal User Creation Input Details to create portal users. Required if the createPortalUsers request parameter is set to true. 65.0
## Response Body for POST [Insurance Person Accounts and Users Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_accounts_and_users_creation_output.htm "Output representation of the person account and user creation process.") # Insurance Person Accounts and Users Creation Input Input representation for creating person accounts and portal users from group census members. ## JSON Example This is a sample JSON example with GroupCensusId. { "groupCensusId": "0rfxx0000000007AAA", "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } This is a sample JSON example with GroupCensusMembers. { "groupCensusMemberIdList": { "values": \[ "0r6xx0000000002AAA", "0r6xx000000004rAAA" \] }, "matchingKeyList": { "values": \[ "FirstName", "LastName" \] }, "fieldMappings": { "data": { "FirstName": "FirstName", "Lastname": "LastName" } }, "userDetails": { "profileId": "00exx000000mzxC", "localeSidKey": "en\_US", "timeZoneSidKey": "America/New York", "languageLocaleKey": "en\_US", "emailEncodingKey": "UTF-8" } } ## Properties
Name Type Description Required or Optional Available Version
fieldMappings Map<String, String> Map of field API names from the Group Census Member object (key) to the Account object (value). Optional 65.0
groupCensusId String ID of the group census that contains the members to process. Optional 65.0
groupCensusMember​IdList String[] IDs of the group census members for whom you want to create person accounts and users.

If not provided, all members of the specified group census are processed.

 Optional 65.0
matchingKeyList String[] List of field API names on the Group Census Member object that are used to identify and prevent the creation of duplicate person accounts.

The default fields are FirstName, LastName, PersonBirthdate, PersonEmail, and PersonGender.

 Optional 65.0
personAccount​RecordType String Developer name of the person account record type to use for the new accounts. Optional 65.0
userDetails Portal User Creation Input Details to create portal users. Required if the createPortalUsers request parameter is set to true. 65.0
# Insurance Person Accounts and Users Creation Response Output representation of the person account and user creation process. ## JSON Example This is a sample JSON example for a successful API request. { "accountsAndUsersDetails": \[ { "groupCensusId": "0rfxx00000001Qv", "groupCensusMemberId": "0r6xx00000002uR", "personAccountId": "001xx000003GeCV" }, { "groupCensusId": "0rfxx00000001Qv", "groupCensusMemberId": "0r6xx00000002uU", "personAccountId": "001xx000003GeCW" } \], "errors": \[\], "isSuccess": true } This is a sample JSON example with error. { "accountsAndUsersDetails": \[ { "groupCensusId": "0rfxx00000001Qr", "groupCensusMemberId": "0r6xx00000002sB", "personAccountId": "001xx000003GeE7" }, { "groupCensusId": "0rfxx00000001Qr", "groupCensusMemberId": "0r6xx00000002sC", "personAccountId": "001xx000003GeE8" } \], "errors": \[ { "additionalInfo": {}, "code": "SF-0004-0047", "message": "Ensure to set the isPortalUser flag to true for group census members 0r6xx00000002sB,0r6xx00000002sC." } \], "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accountsAnd​UsersDetails | [Insurance Member Account and User Details\[\]](connect_responses_insurance_member_account_and_user_details_output.htm "Output representation of a member's person account and portal user details that are created.") | Details of the objects that contain the IDs of the person accounts and users that are created and mapped to their source group census members. | Small, 65.0 | 65.0 | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Details of errors that occurred during the operation. Each error includes details about why a specific group census member failed to process. | Small, 65.0 | 65.0 | | groupCensusId | String | ID of the group census that's processed. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the overall operation was successful (true) or not (false). If any member fails to process, this value is false. | Small, 65.0 | 65.0 | # Insurance Plan Details Output representation for contract group plans. ## JSON Example { "attributes": \[\], "coverages": \[\], "isOptional": false, "isPrimarySubscribed": true, "isSubscribed": true, "planDescription": "Gold medical coverage", "planId": "0gpp00000004C9wAAE", "planName": "Gold Plan" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | [Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.")\[\] | Attributes for the plan. | Small, 65.0 | 65.0 | | coverages | [Insurance Plan Details](# "Output representation for contract group plans.")\[\] | Coverages for the contract group plan. | Small, 65.0 | 65.0 | | isOptional | Boolean | Indicates if the plan is optional for the group census member (true) or not (false). | Small, 65.0 | 65.0 | | isPrimary​Subscribed | Boolean | Indicates if the primary group census member is subscribed to the plan (true) or not (false). | Small, 65.0 | 65.0 | | isSubscribed | Boolean | Indicates if the group census member is subscribed to the plan (true) or not (false). | Small, 65.0 | 65.0 | | planDescription | String | Description of the contract group plan. | Small, 65.0 | 65.0 | | planId | String | ID of the contract group plan. | Small, 65.0 | 65.0 | | planName | String | Name of the contract group plan. | Small, 65.0 | 65.0 | # Insurance Plan List Output representation for a list of contract group plans. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | values | [Insurance Plan Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plan_output.htm "Output representation for contract group plans.")\[\] | List of contract group plan values. | Small, 65.0 | 65.0 | # Insurance Plan Rating Output representation of an individual plan's pricing result. ## JSON Example { "id": "0kfMedicalPlanId01", "rates": { "data": { "total": 350 } }, "proratedRates": { "data": { "total": 350 } }, "contributions": { "employeePremiumAmount": 100, "employerPremiumAmount": 250, "groupClassContributionId": "gcc-001-a", "errors": \[\] }, "coverages": \[ { "coverageId": "cov-hosp-01", "rates": { "data": { "total": 350 } }, "proratedRates": { "data": { "total": 350 } }, "contributions": { "employeePremiumAmount": 100, "employerPremiumAmount": 250, "groupClassContributionId": "gcc-001-a", "errors": \[\] } } \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contributions | [Insurance Contribution](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contribution_output.htm "Output representation of contribution information in an individual rating.") | Contribution details for the plan, if applicable. | Small, 65.0 | 65.0 | | coverages | [Insurance Coverage Rating\[\]](connect_responses_insurance_coverage_rating_output.htm "Output representation of an individual coverage's pricing result.") | Coverage details for the insurance plan. | Small, 65.0 | 65.0 | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | Error details. | Small, 65.0 | 65.0 | | id | String | ID of the plan for which the rating is calculated. | Small, 65.0 | 65.0 | | rates | [Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.") | Rate details for each plan. | Small, 65.0 | 65.0 | | proratedRates | [Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm "Output representation for a map of attributes with string keys and object values.") | Prorated rates for the specified plan. | Small, 65.0 | 65.0 | # Insurance Plans Eligibility Check (POST, PATCH) 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). ## Resource {memberId} is a placeholder. /connect/insurance/census-management/group-census-members/{memberId}/enrollment-rules/actions/invoke ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/census-management/group-census-members/0r6RM0000000h1pYAA/enrollment-rules/actions/invoke ## Available Version 66.0 ## HTTP Methods POST, PATCH ## Path Parameter for POST and PATCH | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member. | Required | 66.0 | ## Request Body for POST ### JSON Example { "plans": { "values": \[ { "planId": "8ckxx000000000001", "attributes": { "values": \[ { "attributeCode": "AGE\_BAND", "attributeValue": "18-25" } \] }, "coverages": { "values": \[ { "planId": "8ckxx000000000002", "attributes": { "values": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Employee Only" } \] } }, { "productCode": "01txx000000000001" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | plans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans for initial eligibility validation. | Required | 66.0 | ## Response Body for POST [Insurance Plans Eligibility Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plans_eligibility_output.htm "Output representation of the insurance plan eligibility check.") ## Request Body for PATCH ### JSON Example { "contextId": "42ce00ea6a44dcc0d308ba1ea7c4c9bb455bd14bb0405ff03dca1b5371c42cda", "addedPlans": { "values": \[ { "planId": "8ckxx000000000001", "attributes": { "values": \[ { "attributeCode": "AGE\_BAND", "attributeValue": "18-25" } \] }, "coverages": { "values": \[ { "planId": "8ckxx000000000002", "attributes": { "values": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Employee Only" } \] } }, { "productCode": "01txx000000000001" } \] } } \] }, "deletedPlans": \[\], "updatedPlans": \[\] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to add to the member's enrollment for eligibility checking. | Optional | 66.0 | | contextId | String | ID of the context. | Required | 66.0 | | deletedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to remove from the member's enrollment. | Optional | 66.0 | | updatedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to update during member enrollment. | Optional | 66.0 | ## Response Body for PATCH [Insurance Plans Eligibility Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plans_eligibility_output.htm "Output representation of the insurance plan eligibility check.") # Insurance Plans Eligibility Create Context Input Input representation for checking plan eligibility by creating a new context. ## JSON Example { "plans": { "values": \[ { "planId": "8ckxx000000000001", "attributes": { "values": \[ { "attributeCode": "AGE\_BAND", "attributeValue": "18-25" } \] }, "coverages": { "values": \[ { "planId": "8ckxx000000000002", "attributes": { "values": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Employee Only" } \] } }, { "productCode": "01txx000000000001" } \] } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | plans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans for initial eligibility validation. | Required | 66.0 | # Insurance Plans Eligibility Details Output representation of the insurance plan eligibility check. ## JSON Example { "memberId": "0BMxx000000000001", "contextId": "42ce00ea6a44dcc0d308ba1ea7c4c9bb455bd14bb0405ff03dca1b5371c42cda", "isSuccess": true, "planEligibilityDetails": { "plans": \[ { "planId": "8ckxx000000000001", "planName": "Group Medical Plan", "productCategory": "Medical", "isOptional": false, "attributes": \[ { "entries": \[ { "key": "AGE\_BAND", "value": "18-25" } \] } \], "coverages": \[ { "planId": "8ckxx000000000002", "planName": "Dental Coverage", "productCategory": "Dental", "isOptional": true, "attributes": \[\], "uiTreatments": \[ { "uiTreatmentType": "disable", "uiTreatmentTarget": "attribute\_picklist\_value", "details": { "planId": "8ckxx000000000002", "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "0", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceZero", "attributePicklistValueId": "0v6xx000000000SAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" }, { "details": { "attributeId": "0tjxx000000000DAAQ", "attributeCode": "inCoverageCoinsurance", "attributeValue": "10", "stiId": "ref\_4316263b\_b30e\_45fd\_ad18\_d2830d96f597", "attributePicklistValue": "CoinsuranceTen", "attributePicklistValueId": "0v6xx000000000TAAQ" }, "uiTreatmentTarget": "attribute\_picklist\_value", "uiTreatmentType": "hide" } \] } \], "uiTreatments": \[ { "details": { "attributeId": "0tjxx000000000cAAA", "attributeCode": "onmedFees", "stiId": "ref\_875915aa\_61c4\_4916\_ae58\_9fa7e0dec529", "attributeName": "Out-Network ICU Fees" }, "uiTreatmentTarget": "attribute", "uiTreatmentType": "hide" } \] } \], "messages": \[ { "message": "Plan eligibility evaluated successfully.", "messageType": "INFO" } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context that's used for the eligibility check. | Small, 66.0 | 66.0 | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred during the eligibility check. | Small, 66.0 | 66.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Small, 66.0 | 66.0 | | memberId | String | ID of the group census member. | Small, 66.0 | 66.0 | | planEligibility​Details | [Eligible Plan Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_eligible_plan_details_output.htm "Output representation for the details of the eligible plans.") | Details of the eligible plans. | Small, 66.0 | 66.0 | # Insurance Plans Eligibility Update Context Input Input representation for checking plan eligibility by updating an existing context. ## JSON Example { "contextId": "42ce00ea6a44dcc0d308ba1ea7c4c9bb455bd14bb0405ff03dca1b5371c42cda", "addedPlans": { "values": \[ { "planId": "8ckxx000000000001", "attributes": { "values": \[ { "attributeCode": "AGE\_BAND", "attributeValue": "18-25" } \] }, "coverages": { "values": \[ { "planId": "8ckxx000000000002", "attributes": { "values": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Employee Only" } \] } }, { "productCode": "01txx000000000001" } \] } } \] }, "deletedPlans": \[\], "updatedPlans": \[\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to add to the member's enrollment for eligibility checking. | Optional | 66.0 | | contextId | String | ID of the context. | Required | 66.0 | | deletedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to remove from the member's enrollment. | Optional | 66.0 | | updatedPlans | [Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm "Input representation for group census member plans and their coverages.")\[\] | List of contract group plans to update during member enrollment. | Optional | 66.0 | # Insurance Policy Administration Use the Insurance Policy developer resources to manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation. Each transaction type creates an InsurancePolicyTransaction record.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
- **[Insurance Policy Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_business_api_overview.htm)** Manage policy transactions such as issuance, endorsement, renewal, and cancellation. Calculate term taxes based on transaction types and policy durations. - **[Insurance Policy Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_invocable_actions_parent.htm)** Use the standard invocable actions available with Insurance Policy to create, manage, and endorse insurance policies. - **[Insurance Policy Administration Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_administration_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. - **[Insurance Policy Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_standard_objects_parent.htm)** The Insurance Policy data model provides objects and fields to manage insurance policy transactions. - **[Insurance Policy Administration Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_apex_reference.htm)** Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Policy Administration Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[Insurance Policy Developer Journey](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_developer_journey.htm)** To manage insurance policies by using Salesforce Quoting, use the Quoting APIs to generate a quote context, which serves as the foundation for policy operations. For managing policies without Salesforce Quoting, use the Rating API to create a price-adjusted context. This price-adjusted context provides the necessary rated data to manage insurance policies without depending on a formal quote record. # Insurance Policy Administration Apex Reference Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control statements on the Salesforce Platform server, in conjunction with calls to the API. Insurance Policy Administration Apex reference includes built-in Apex classes and interfaces, grouped by namespace. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_connect_api_namespace.htm)** The ConnectApi namespace (also called Connect in Apex) in Insurance Policy Administration provides classes for accessing the same data available in the Insurance Policy Administration Business APIs. # Insurance Policy Administration Error Codes Contains the error codes and error code messages that are applicable to the Insurance Policy Administration APIs. | Error Code | HTTP Response Code | Message | | --- | --- | --- | | SF-0003-0001 | 400 | The cancellation effective date can’t be on or after {cancellationEffectiveDate}. | | SF-0003-0002 | 400 | Specify a cancellation effective date that is after {originalEffectiveFromDate} and before {originalEffectiveToDate}. | | SF-0003-0003 | 400 | The policy ID {insurancePolicyId} does not exist. Specify a valid policy ID and try again. | | SF-0003-0004 | 400 | We couldn’t find the accountId in the context. Specify an accountId. | | SF-0003-0005 | 400 | Specify an endorsement date that's between {effectiveFromDate} and {effectiveToDate}. | | SF-0003-0006 | 400 | The field set IDs {invalidIds} aren’t associated with the entities {entitiesList}. Specify valid field set IDs and try again. | | SF-0003-0007 | 400 | Specify only one field set ID for {entitiesList} and try again. | # Insurance Policy Administration Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Policy Administration. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Policy Administration](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_administration_flow_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Policy Administration exposes additional actionType values for the FlowActionCall Metadata type. # Insurance Policy Billing Details Input representation for insurance policy billing. ## JSON Example { "billDayOfMonth": 12, "billToContact": "003xx000000001aEAA", "billingType": "Agency" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | billDayOfMonth | Integer | Day of the month on which the bill must be generated. | Required | 67.0 | | billToContact | String | Contact ID to use for billing. | Required | 67.0 | | billingType | String | Billing type to use for the insurance policy. | Required | 67.0 | # Insurance Policy Bulk Field Map Input Representation Input representation for Insurance Policy Bulk lifecycle process APIs with per-policy field value maps. ## JSON Example { "policies": \[ { "policyId": "0YTxx00000000mPGAQ", "fieldValueMap": { "reinstatementDate": "2026-01-15" } } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policies | Object | List of insurance policies with their field value maps. | Required | 67.0 | # Insurance Policy Bulk Input Input representation for bulk policy operations. Specify the list of insurance policy IDs and field value map of insurance policy fields for bulk operations. ## JSON Example { "insurancePolicyIds": \["0IFxx0000004C1PGAU", "0IFxx0000004C1QGAU"\], "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 64.0 | | insurancePolicyIds | Object | List of insurance policy IDs to perform bulk operations. | Required | 64.0 | # Insurance Policy Bulk Response Output representation for bulk policy lifecycle operations. ## JSON Example This example shows a sample success response. { "status": "Success", "message": "Request was submitted." } This example shows a sample error response. { "status": "Failure", "message": "We couldn't submit this request. Contact your Salesforce admin for help or try again in a bit.", "errors": \[ { "code": "", "message": "" } \] }
Property Name Type Description Filter Group and Version Available Version
errors Error Response List of errors encountered during the processing of the API request. Small, 63.0 63.0
message String Status message of the API execution. Small, 63.0 63.0
status String Status of the API execution. Valid values are:
  • Success
  • Fail
 Small, 63.0 63.0
# Insurance Policy Business APIs Manage policy transactions such as issuance, endorsement, renewal, and cancellation. Calculate term taxes based on transaction types and policy durations. This table lists the available Insurance Policy Administration resources. | Resource | Description | | --- | --- | | [/connect/insurance/policies/policyId/cancel](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cancel_policy.htm "Cancel an insurance policy version. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation.") (POST) | Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON. | | [/connect/insurance/policies/policyId/endorse](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_endorse_policy.htm "Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the request body.") (POST) | Endorse the latest version of the insurance policy based on the context ID and effective date. | | [/connect/insurance/policies/policyId?\_qs=contextOnly=true](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.") (GET) | Get the ID of the context and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information. | | [/connect/insurance/policies](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_policy.htm "Use the context ID provided in the request body to generate a new insurance policy.") (POST) | Use the context ID provided in the input JSON to generate a new insurance policy. | | [/connect/insurance/policies/policyId/renew](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_renew_policy.htm "Renew policy for the specified insurance policy ID.") (POST) | Use the context ID of an existing policy to renew a policy. Modify the renewal date and also add optional fields and additional information in the input JSON. | | [/connect/insurance/policies/policyId/out-of-sequence-endorsement](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_out_of_sequence_endorsement.htm "Create an out-of-sequence endorsement for an insurance policy.") (POST) | Create an out-of-sequence endorsement for an insurance policy. | | [/connect/insurance/policies/policyId/reinstate](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_reinstate.htm "Reinstate a previously canceled insurance policy.") (POST) | Reinstate a previously canceled insurance policy. | | [/connect/insurance/policies/multi-root](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_multi_root_issue_policy.htm "Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy.") (POST) | Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy. | | [/connect/insurance/policies/multi-root/endorse](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_multi_root_endorsement_policy.htm "Asynchronously endorse a multi-root insurance policy along with its child policies.") (POST) | Asynchronously endorse a multi-root insurance policy along with its child policies. | | [/connect/insurance/policies/multi-root/renew](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_multi_root_renew.htm "Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies.") (POST) | Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_business_apis_resources.htm)** Learn more about the available Insurance Policy API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_business_apis_requests.htm)** Learn more about the available Insurance Policy requests. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_policy_business_apis_responses.htm)** Learn more about the available response bodies of Insurance Policy APIs. # Insurance Policy Cancellation Input Send the cancellation details to cancel an insurance policy, including the effective date, reason, and target status. ## JSON Example { "cancellationEffectiveDate": "2026-07-01", "cancellationReason": "Non-payment", "status": "Cancelled" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | cancellationEffectiveDate | String | Date after which the policy is no longer valid. Use the format YYYY-MM-DD. | Required | 67.0 | | cancellationReason | String | Reason for canceling the insurance policy. | Optional | 67.0 | | status | String | Target status of the canceled policy, such as Canceled. | Optional | 67.0 | # Insurance Policy Cancellation Response Output representation details of the cancel policy request. ## JSON Example This example shows a sample success response. { "errors": \[\], "impactedPolicyVersions": \["0YTxx0000000002GAA", "0YTxx0000000003GAA"\], "transactionId": "a1xx0000000001AAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 67.0 | 67.0 | | impactedPolicyVersions | List | List of insurance policy version IDs impacted by the cancellation. | Small, 67.0 | 67.0 | | transactionId | String | Unique identifier of the transaction record that's created for the policy cancellation process. | Small, 67.0 | 67.0 | # Insurance Policy Details (GET) Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information. ## Resource {policyId}, {fieldSetIds}, and {fieldSetId} are placeholders. /connect/insurance/policies/{policyId}?\_qs=contextOnly=true /connect/insurance/policies/{policyId}?\_qs=expand\[attributes\]=true /connect/insurance/policies/{policyId}?\_qs=expand\[attributes\]=true&expand\[surcharges\]=true /connect/insurance/policies/{policyId}?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]={fieldSetIds} /connect/insurance/policies/{policyId}?\_qs=expand\[additionalFields\]\[fieldSet\]\[$eq\]={fieldSetId} /connect/insurance/policies/{policyId}?\_qs=expand\[additionalFields\]\[fieldSet\]\[$eq\]={fieldSetId};contextOnly=true /connect/insurance/policies/{policyId}?\_qs=expand\[additionalFields\]\[fieldSet\]\[$eq\]={fieldSetId};expand\[attributes\]=true /connect/insurance/policies/{policyId}?\_qs=expand\[additionalFields\]\[fieldSet\]\[$eq\]={fieldSetId};expand\[attributes\]=true&expand\[surcharges\]=true ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[attributes\]=true https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA?\_qs=expand\[attributes\]=true&expand\[surcharges\]=true https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?\_qs=contextOnly=true https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]=0IXSG000001ADt34AG,0IXSG000001AUp34AG https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;contextOnly=true https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?\_qs=expand\[additionalFields\]\[fieldSet\]\[$in\]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;expand\[attributes\]=true https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA?\_qs=expand\[surcharges\]=true ## Available Version 63.0 ## HTTP Methods GET ## Request Parameters for GET | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | connectDynamicParameters | Map | Map of connect dynamic parameters. | Optional | 63.0 | ## Response Body for GET [Get Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_policy_output.htm "Output representation of policy details.") # Insurance Policy Developer Journey To manage insurance policies by using Salesforce Quoting, use the Quoting APIs to generate a quote context, which serves as the foundation for policy operations. For managing policies without Salesforce Quoting, use the Rating API to create a price-adjusted context. This price-adjusted context provides the necessary rated data to manage insurance policies without depending on a formal quote record. - **[Create and Manage Insurance Policies by Using Salesforce Quoting](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/manage_policy_using_quote.htm)** Learn how to effectively use the Insurance Policy and Quoting Connect APIs, along with the associated invocable actions, to build comprehensive user journeys by using Salesforce Flows and Omniscripts. - **[Create and Manage Insurance Policies Without Using Salesforce Quoting](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/manage_policy_without_using_quote.htm)** Learn how to use the Insurance Policy APIs and invocable actions to manage the policy lifecycle when Salesforce quoting isn't used, or when a third-party system handles the quoting process. - **[Cancel Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/cancel_policy.htm)** The policy cancellation process addresses the termination of an insurance policy before its scheduled expiration date. Common reasons for canceling a policy include not paying the premiums or a direct cancellation request from the policyholder. # Insurance Policy Draft Input Send the field value map of insurance policy fields to create a draft endorsement for the specified policy. ## JSON Example "fieldValueMap": { "EffectiveFromDate": "2026-06-01" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains key-value pairs to store details of insurance policy. The key must be the API name and is case sensitive. | Required | 67.0 | # Insurance Policy Draft Response Output representation details of the endorsement draft policy request. ## JSON Example This example shows a sample success response. { "errors": \[\], "policyId": "0YTxx0000000001GAA" } This example shows a sample error response. { "errors": \[{ "code": "SF-INS-BRKG-00010", "message": "Ensure that policy is in Draft - Endorse stage to endorse a policy." }\], "policyId": "0YTxx0000000001GAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 67.0 | 67.0 | | policyId | String | ID of the insurance brokerage policy for which a draft endorsement is created. | Small, 67.0 | 67.0 | # Insurance Policy Input Input representation of insurance policy details. ## JSON Example insurancePolicy": { "policyName": "Mr. Bret Lees Policy", "policyNumber": "Policy-Bret-OneYear", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-10-31", "referencePolicyNumber": "00AXSYH567INS" } ## Properties
Name Type Description Required or Optional Available Version
effectiveFromDate String Date that the policy is effective from.

This property isn't applicable to the policy endorsement and reinstatement APIs.

 Optional 63.0
effectiveToDate String Expiration date of the policy.

This property isn't applicable to the policy endorsement and reinstatement APIs.

 Optional 63.0
policyName String Name of the insurance policy. Optional 63.0
policyNumber String Number of the policy. Optional 63.0
referencePolicy​Number String Reference number that's used to link policies across terms.

If not specified, policies are linked by the insurance policy ID.

This property is applicable to the Issue Policy API and supports both single-root and multi-root policies.

 Optional 65.0
# Insurance Policy Issue Details Output representation details of the issue policy and issue endorse policy requests. ## JSON Example This example shows a sample success response. { "errors": \[\], "transactionId": "0k9xx00000000CvAAI" } This example shows a sample error response. { "errors": \[{ "code": "SF-INS-COM-00013", "message": "Something went wrong and we couldn’t issue the policy. Try again or ask your Salesforce admin for help." }\], "transactionId": "" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 67.0 | 67.0 | | transactionId | String | Unique identifier of the transaction that's created for the policy issuance or endorsement process. | Small, 67.0 | 67.0 | # Insurance Policy Limit Calculation Standing Node Output representation for an insurance policy limit standing calculation node. ## JSON Example { "insPolicyLmtCalcStandingNode": \[ { "applicableAction": \[ "PaymentAttempted" \], "category": "LimitCurrency", "claimCoverageId": "0cYSG000000UYlp2AG", "claimId": "500SG0000009HjJ2AU", "durationType": "PolicyTerm", "initialAmount": 1000, "initialValue": 0, "parentMappedScopeId": "0YTxx0000000253GAA", "pendingAmount": 500, "pendingValue": 0, "policyAssetId": "", "policyCoverageId": "0cYSG000000UYlq2AG", "parentPolicyCoverageId": "0YTxx00000000PpGAI", "policyLimitId": "1TDSG0000007HU84AM", "policyLimitStandingKey": "PolicyCoverage LimitCurrency", "policyParticipantId": "003SG0000005pIkJAI", "predictedRemainingAmount": 500, "predictedRemainingValue": 0, "scope": "PolicyCoverage", "remainingAmount": 1000, "remainingValue": 0, "totalUsedAmount": 0, "totalUsedValue": 0, "trackingStartDate": "2025-10-09", "trackingEndDate": "2025-12-19" } \] }
Property Name Type Description Filter Group and Version Available Version
applicable​Actions String[] List of actions that initiate attribute processing. Big, 65.0 65.0
category String Category of the limit. Big, 65.0 65.0
claimCoverage​Id String ID of the claim coverage record. Big, 65.0 65.0
claimId String ID of the claim record. Big, 65.0 65.0
durationType String Duration type over which attribute consumption is monitored. Big, 65.0 65.0
initialAmount Double Configured amount. Big, 65.0 65.0
initialValue Integer Configured value of the limit. Big, 65.0 65.0
itemType String Type of the item. Big, 65.0 65.0
parentMapped​ScopeId String ID of the parent product or coverage that this attribute applies to. Big, 65.0 65.0
parentPolicy​CoverageId String ID of the parent policy coverage to which the specified policy coverage (policyCoverageId) belongs. Big, 67.0 67.0
pendingAmount Double Total pending amount for open claims or unfinalized transactions, even if the amount exceeds the initial limit. Big, 65.0 65.0
pendingValue Integer Value that's pending. Big, 65.0 65.0
policyAssetId String ID of the related policy asset. Big, 65.0 65.0
policy​CoverageId String ID of the policy coverage to get the applicable policy limit consumption details. Big, 65.0 65.0
policy​LimitId String ID of the insurance policy limit record. Big, 65.0 65.0
policyLimit​StandingKey String Unique identifier for the insurance policy limit standing. Big, 65.0 65.0
policy​ParticipantId String ID of the policy participant. Big, 65.0 65.0
predictedRemainingAmount Double Remaining amount after calculating the pending value. Big, 65.0 65.0
predicted​RemainingValue Integer Remaining value after calculating the pending value. Big, 65.0 65.0
prodtAttr​MappedScopeId String ID of the product or coverage that this attribute applies to. Big, 65.0 65.0
remaining​Amount Double Remaining amount to carry forward. Big, 65.0 65.0
remaining​Value Integer Remaining value to carry forward. Big, 65.0 65.0
scope String Scope where the limit is applied, such as policy, claim, policy coverage. Big, 65.0 65.0
subCoverageName String Name of the sub-coverage. Big, 65.0 65.0
totalUsed​Amount Double Total amount that's used against this limit to date.

It shows the actual total amount that's used, even if that amount exceeds the defined maximum limit.

 Big, 65.0 65.0
totalUsed​Value Integer Total value that's used against this limit to date. Big, 65.0 65.0
trackingEndDate Date End date of the duration period that’s used to calculate the current standing. Big, 66.0 66.0
trackingStartDate Date Start date of the duration period that’s used to calculate the current standing. Big, 66.0 66.0
# Insurance Policy Limit Current Standings (POST) Get the calculated current standings (consumption status) for all applicable insurance policy limits. This API retrieves standings based on the policy, claim, claim coverage as well as policy coverage, insurance policy participant, and insurance policy asset. This API accepts only one ID per request, either policyId or claimId. ## Resource /connect/insurance/policy-limit/calculate-standings ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policy-limit/calculate-standings ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example This example queries for standings at the entire policy level, using the viewOption parameter to get a summary, including pending amounts. { "policyId": "01t000000000000001", "claimId": null, "claimCoverageId": null, "policyParticipantId": null, "policyAssetId": null, "policyCoverageId": null, "trackingDate": "2025-10-19", "options": { "viewOption": "showAllPolicyCoverages", "shouldIncludePendingAmount": true } } This example gets the specific limits that are impacted by a single claim, excluding pending amounts. { "policyId": null, "claimId": "01t000000000000001", "claimCoverageId": null, "policyParticipantId": null, "policyAssetId": null, "policyCoverageId": null, "trackingDate": "2025-10-19", "options": { "viewOption": "showOpenClaimPolicyCoverages", "shouldIncludePendingAmount": false } } ### Properties
Name Type Description Required or Optional Available Version
claimCoverageId String ID of the claim coverage record. Optional 65.0
claimId String ID of the claim. Required to get the standings for a claim 65.0
options Limit Standing Option Input Options for the calculation. Optional 65.0
policyAssetId String ID of the policy asset. Optional 65.0
policy​CoverageId String ID of the policy coverage record. Optional 65.0
policyId String ID of the insurance policy. Required to get the standings for a policy 65.0
policy​ParticipantId String ID of the policy participant. Optional 65.0
trackingDate Date Date on which the standing is calculated.

The default value is the current system date.

 Optional 66.0
## Response Body for POST [Insurance Policy Limit Current Standings Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_lmt_calc_standing.htm "Output representation for the current standings of the insurance policy limits.") # Insurance Policy Limit Current Standings Input Input representation for the current standings of the insurance policy limits. ## JSON Example This example queries for standings at the entire policy level, using the viewOption parameter to get a summary, including pending amounts. { "policyId": "01t000000000000001", "claimId": null, "claimCoverageId": null, "policyParticipantId": null, "policyAssetId": null, "policyCoverageId": null, "trackingDate": "2025-10-19", "options": { "viewOption": "showAllPolicyCoverages", "shouldIncludePendingAmount": true } } This example gets the specific limits that are impacted by a single claim, excluding pending amounts. { "policyId": null, "claimId": "01t000000000000001", "claimCoverageId": null, "policyParticipantId": null, "policyAssetId": null, "policyCoverageId": null, "trackingDate": "2025-10-19", "options": { "viewOption": "showOpenClaimPolicyCoverages", "shouldIncludePendingAmount": false } } ## Properties
Name Type Description Required or Optional Available Version
claimCoverageId String ID of the claim coverage record. Optional 65.0
claimId String ID of the claim. Required to get the standings for a claim 65.0
options Limit Standing Option Input Options for the calculation. Optional 65.0
policyAssetId String ID of the policy asset. Optional 65.0
policy​CoverageId String ID of the policy coverage record. Optional 65.0
policyId String ID of the insurance policy. Required to get the standings for a policy 65.0
policy​ParticipantId String ID of the policy participant. Optional 65.0
trackingDate Date Date on which the standing is calculated.

The default value is the current system date.

 Optional 66.0
# Insurance Policy Limit Current Standings Response Output representation for the current standings of the insurance policy limits. ## JSON Example { "isSuccess": true, "errors": \[\], "insPolicyLmtCalcStandingNode": \[ { "applicableAction": \[ "PaymentAttempted" \], "category": "LimitCurrency", "claimCoverageId": "0cYSG000000UYlp2AG", "claimId": "500SG0000009HjJ2AU", "durationType": "PolicyTerm", "initialAmount": 1000, "initialValue": 0, "parentMappedScopeId": "0YTxx0000000253GAA", "pendingAmount": 500, "pendingValue": 0, "policyAssetId": "", "policyCoverageId": "0cYSG000000UYlq2AG", "policyLimitId": "1TDSG0000007HU84AM", "policyLimitStandingKey": "PolicyCoverage LimitCurrency", "policyParticipantId": "003SG0000005pIkJAI", "predictedRemainingAmount": 500, "predictedRemainingValue": 0, "scope": "PolicyCoverage", "remainingAmount": 1000, "remainingValue": 0, "totalUsedAmount": 0, "totalUsedValue": 0, "trackingStartDate": "2025-10-09", "trackingEndDate": "2025-12-19" } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | List of errors for calculate standings. | Big, 65.0 | 65.0 | | insPolicyLmt​CalcStanding​Nodes | [Insurance Policy Limit Calculation Standing Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_lmt_calc_standing_node.htm "Output representation for an insurance policy limit standing calculation node.")\[\] | List of policy limit current standing nodes. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # Insurance Policy Process Output representation details of the renewed policy. ## JSON Example This example shows a sample success response. { "errors": \[{ "code": "", "message": "" }\], "status": "Success", "policyId": "testId", "message": "policy renewed successfully." } This example shows a sample error response. { "errors": \[{ "code": "", "message": "" }\], "status": "Fail", "policyId": "", "message": "error message." } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the renewed policy. | Small, 63.0 | 63.0 | # Insurance Policy Reinstatement Input Send the reinstatement details to reinstate a canceled insurance policy, including the reinstatement date and any policy field overrides. ## JSON Example { "reinstatementDate": "2024-06-01", "insurancePolicy": { "policyName": "Reinstated Policy Name", "policyNumber": "POL-2024-001", "Custom\_field": "value" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insurancePolicy | Object | JSON object that contains insurance policy fields to override in the reinstated policy. The keys must be API names and are case sensitive. | Optional | 67.0 | | reinstatementDate | String | Date when the policy becomes effective. Use the format YYYY-MM-DD. | Required | 67.0 | # Insurance Policy Reinstatement Response Output representation details of the reinstate policy request. ## JSON Example This example shows a sample success response. { "errors": \[\], "policyId": "0YTxx0000000001GAA", "transactionId": "0k9xx00000000CvAAI" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/platform/connect-rest-api/guide/connect_error_responses.html "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 67.0 | 67.0 | | policyId | String | ID of the policy that's reinstated. | Small, 67.0 | 67.0 | | transactionId | String | Unique identifier of the transaction that's generated during the policy reinstatement process. | Small, 67.0 | 67.0 | # Insurance Policy Renew Input Input representation of the details of the request to renew policy. ## JSON Example { "fieldValueMap": { "Name": "demo" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains name-value pairs that store details of insurance policy. | Required | 63.0 | # Insurance Policy Standard Invocable Actions Use the standard invocable actions available with Insurance Policy to create, manage, and endorse insurance policies. - **[Cancel Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_cancel_insurance_policy.htm)** Cancel an insurance policy by using a set of user inputs that represent policy details. - **[Create Out-of-sequence Policy Endorsement Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_out_of_sequence_policy_endorsement.htm)** Create an out-of-sequence endorsement for an insurance policy. - **[Endorse Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_insurance_policy.htm)** Endorse an insurance policy by using a set of user inputs that represent policy details. - **[Endorse Multi-Root Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_endorse_multi_root_insurance_policy.htm)** Create an endorsement for an existing multi-root insurance policy to apply updates or changes to the policy and its associated child policies. - **[Get Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm)** Get the details of an insurance policy. - **[Issue Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_insurance_policy.htm)** Issue an insurance policy by using a set of user inputs that represent policy details. - **[Issue Multi-Root Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_multi_root_insurance_policy.htm)** Create a new multi-root insurance policy along with its associated child policies asynchronously. - **[Reinstate Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_reinstate_insurance_policy.htm)** Reinstate a previously canceled insurance policy. - **[Renew Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_insurance_policy.htm)** Renew an insurance policy by using a set of user inputs that represent policy details. - **[Renew Insurance Policies Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_insurance_policies.htm)** Process the renewal of insurance policies in bulk. - **[Renew Multi-Root Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_multi_root_insurance_policy.htm)** Renew an existing multi-root insurance policy along with its associated child policies asynchronously. # Insurance Policy Standard Objects The Insurance Policy data model provides objects and fields to manage insurance policy transactions. - **[InsProductClauseVariableMap](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/sforce_api_objects_insproductclausevariablemap.htm)** Represents the mapping between a token defined in an insurance clause and the product attributes that populate the token value at runtime. For example, a Free Look clause allows a customer to cancel a policy within a certain number of days. The number of days is a variable (or, token) that's populated using product-specific attributes. This object is available in API version 65.0 and later. - **[InsuranceClause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/sforce_api_objects_insuranceclause.htm)** Defines the terms and conditions associated with a product. For example, an Avocation Clause excludes coverage if the insured engages in a risky hobby. This object is available in API version 65.0 and later. - **[InsurancePolicyProductClause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/sforce_api_objects_insurancepolicyproductclause.htm)** Represents all clauses associated with the products that are applicable to a specific insurance policy. The object contains one record for each clause associated with a product that is applicable to a policy. This object is available in API version 65.0 and later. - **[InsuranceProductClause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/sforce_api_objects_insuranceproductclause.htm)** Represents a junction between a product and an insurance clause. This association defines the clauses applicable for the specific products. For example, an Excluded Driver clause applies to auto and motorcycle insurance products, but not to home insurance products. This object is available in API version 65.0 and later. - **[QuoteLineItemInsProductClause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/sforce_api_objects_quotelineiteminsproductclause.htm)** Represents all clauses associated with the products that are applicable to a specific quote line item. For example, if auto insurance quote "ABC" includes both a Free Look clause and an Excluded Driver clause, the object will have two records, one for each clause applicable to the quote line item. This object is available in API version 65.0 and later. # Insurance Policy Transaction Input Input representation of the insurance policy transaction details. ## JSON Example transaction": { "name": Cancel Transaction } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | Name of the transaction, such as Cancel Transaction. | Optional | 63.0 | # Insurance Price Comparison Input Input representation of the optional filters that scope a price comparison for a group census. Use these settings to narrow the comparison to a product category or to specific members, and to control whether to get the plan and coverage attributes in the response. ## JSON Example { "category": "0ZGIO0000000gAX4AY", "fetchAttributes": false, "memberIds": { "values": \[ "0r6IO0000004F25AE" \] } } ## Properties
Name Type Description Required or Optional Available Version
category String ID of the product category to filter the comparison. If not specified, the API returns only the overall summary and the list of available categories. Optional 68.0
fetchAttributes Boolean Indicates whether to return the attributes of the root products and coverages, such as copay and coinsurance (true) or not (false). The default value is false.

If set to true, the API returns plan attribute differences instead of price comparison details.

 Optional 68.0
memberIds String[] List of group census member IDs to compare prices for. If not specified, the API returns the summary view of the census instead of member-level comparisons. Optional 68.0
# Insurance Pricing Setup Validation Input Input representation of the quote, transaction type, and products to validate for pricing setup configuration. ## JSON Example { "quoteId": "0Q0xx0000006iPnAAI", "productIds": \["01txx0000006iPnAAI", "01txx0000006iPmAAI"\] } ## Properties Provide at least one of quoteId, transactionType, or productIds for meaningful validation. If none are provided, the API returns isValid as true with no errors. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productIds | String\[\] | List of Product2 record IDs to validate for product-level procedure plan configuration. | Optional | 68.0 | | quoteId | String | Quote record ID. When provided, the quote’s transaction type and date context are used for quote-level validation. | Optional | 68.0 | | transactionType | String | Transaction type developer name. Used for quote-level validation when quoteId isn’t provided, or to override the quote’s transaction type. | Optional | 68.0 | # Insurance Pricing Setup Validation Response Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors. ## JSON Example { "isValid": false, "errors": \[ { "code": "SF-INS-DSAV-00064", "message": "Procedure plan effective dates are not valid for the request: the request date does not fall within the effective start and end dates of the applicable procedure plan." }, { "code": "SF-INS-DSAV-00066", "message": "No product-level procedure plan is defined: the submitted product 01txx0000006iPnAAI does not have a product-level procedure plan configured." } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | Errors encountered during validation. This list includes pricing setup failures such as an invalid transaction type, a missing procedure plan, invalid procedure plan dates, an invalid context definition, or a pricing procedure that doesn’t have an active version for the evaluation date. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether the pricing setup is valid (true) or not (false). This value is true when no errors are detected. | Big, 68.0 | 68.0 | # Insurance Product Administration Use the Insurance Product Administration developer resources to define the products you sell to customers, including their classifications, categories, and attributes. Create customized price adjustment methods and pricing procedures. Define rules that determine how your products behave when they're quoted, sold, and serviced.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
- **[Insurance Product Administration Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_business_api_overview.htm)** Design, manage, and administer insurance products to meet the business requirements. - **[Insurance Product Administration Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_invocable_actions_parent.htm)** Learn more about the standard invocable actions available with Insurance Product Administration. - **[Insurance Product Administration Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. # Insurance Product Administration Business APIs Design, manage, and administer insurance products to meet the business requirements. This table lists the available Insurance Product Administration resources. | Resource | Description | | --- | --- | | [/connect/insurance/underwriting-rules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_create_underwriting_rules.htm "Create an underwriting rule for a root product based on the selected state definition, transition, and object name.") (POST) | Create an underwriting rule for a root product based on the selected state definition, transition, and object name. | | [/connect/insurance/underwriting-rule-group-status/uwrGroupId](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_underwriting_rule_group_status.htm "Update the status of an underwriting rule group.") (PATCH) | Update the status of an underwriting rule group. | | [/connect/insurance/underwriting-rules/underwritingRuleId](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_update_underwriting_rules.htm "Update an existing underwriting rule for a root product.") (PATCH) | Update an existing underwriting rule for a root product. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_business_apis_resources.htm)** Learn more about the available Insurance Product Administration API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_business_apis_requests.htm)** Learn more about the available Insurance Product Administration requests. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_business_apis_responses.htm)** Learn more about the available response bodies of Insurance Product Administration APIs. # Insurance Product Administration Invocable Actions Learn more about the standard invocable actions available with Insurance Product Administration. - **[Invoke Underwriting Rules Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_invoke_underwriting_rules.htm)** Invoke the underwriting rules for different insurance records during the run time. # Insurance Product Administration Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Product Administration. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Product Administration](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_product_administration_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Product Administration exposes additional actionType values for the FlowActionCall Metadata type. # Insurance Product Clause (PATCH) Update an existing product clause for a root product. ## Resource {productClauseId} is a placeholder. /connect/insurance/product-clauses/{productClauseId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-clauses/0j4xx0000000001AAA ## Available Version 65.0 ## HTTP Methods PATCH ## Path Parameter for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauseId | String | ID of the product clause that must be updated. | Required | 65.0 | ## Request Body for PATCH ### JSON Example { "effectiveDate": "2026-01-01", "expirationDate": "2026-12-31", "variableMappings": \[ { "id": "a1Bxx0000000001AAA", "variable": "LimitAmount", "attribute": "NewCoverageLimit" } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date from which the product clause is valid. | Optional | 65.0 | | expirationDate | String | Date from which the product clause is no longer valid. | Optional | 65.0 | | variable​Mappings | [Product Clause Variable Mapping Input\[\]](connect_requests_insurance_product_clause_variable_mapping_input.htm "Input representation for mapping an insurance clause variable to an insurance product variable.") | Variable mappings for the product clause that must be updated. | Optional | 65.0 | ## Response Body for PATCH [Product Clause Update Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_product_clause_output.htm "Output representation of the details for an updated product clause.") # Insurance Product Clause Bulk (POST) Create one or multiple product clauses at once. ## Resource /connect/insurance/product-clauses/bulk ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-clauses/bulk ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productClauses": \[ { "apiName": "AutoGlassClause\_2025", "name": "Auto Glass Clause", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31", "insuranceClauseId": "0j1xx0000000001AAA", "rootProduct": "01t000000003CCC", "productPath": "01t000000003DDD", "variableMappings": \[ { "variable": "DeductibleAmount", "variableType": "Currency", "attribute": "WaiverAmount" }\] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauses | [Product Clause Input\[\]](connect_requests_insurance_create_product_clause_input.htm "Input representation for the details of a single product clause to be created.") | Details to create product clauses. | Required | 65.0 | ## Response Body for POST [Product Clause Creation Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_product_clause_list_output.htm "Output representation for the bulk creation of product clauses.") # Insurance Product Clause Details Output representation for insurance product clause. ## JSON Example { "category": "Manual", "clauseName": "Manual Clause 1", "description": "This is a manually added clause.", "effectiveDate": "2025-10-01T12:00:00.000Z", "expirationDate": "2026-10-01T12:00:00.000Z", "insuranceProductClauseId": "a4Lxx000000Cde1EAC", "type": "Clause" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | category | String | Category of the insurance clause, such as manual or auto-added. | Big, 65.0 | 65.0 | | clauseName | String | Name of the insurance product clause. | Big, 65.0 | 65.0 | | description | String | Description of the insurance product clause. | Big, 65.0 | 65.0 | | effective​Date | String | Date from which the product clause is valid. | Big, 65.0 | 65.0 | | expiration​Date | String | Date from when the product clause is no longer valid. | Big, 65.0 | 65.0 | | insurance​Product​ClauseId | String | ID of the insurance product clause. | Big, 65.0 | 65.0 | | type | String | Type of insurance product provision, such as clause or exclusion. | Big, 65.0 | 65.0 | # Insurance Product Clause Generation (POST) Generate product clauses based on quote and context information. ## Resource /connect/insurance/product-clauses/clause-generation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-clauses/clause-generation ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000000001AAA", "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "quoteLineItemIds": \[ "0QLxx0000000003CCC" \], "instanceKeys": \[ { "instanceKey": \[ "Auto", "Liability" \] } \], "options": { "generateClausesAsync": true, "generateManualClauses": false, "saveContext": true } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context based on which the product clause is generated. | Required if quoteId isn't specified | 65.0 | | instanceKeys | [Instance Key Input\[\]](connect_requests_instance_key_input.htm "Input representation for a single instance key array.") | List of instance keys. | Optional | 65.0 | | options | [Clause Generation Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_clause_generation_options_input.htm "Input representation for clause generation options.") | Options for clause generation. | Optional | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quote​LineItem​Ids | String\[\] | IDs of the quote line items. | Optional | 65.0 | ## Response Body for POST [Product Clause Generation Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_clause_generation_output.htm "Output representation of the details for a clause generation request.") # Insurance Product Clause Input Input representation for a single insurance product clause. ## JSON Example { "effectiveDate": "2025-10-27T12:00:00.000Z", "expirationDate": "2026-10-27T12:00:00.000Z", "insuranceProductClauseId": "a4Lxx000000Cde1EAC" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date from which the product clause is valid. | Optional | 65.0 | | expirationDate | String | Date from which the product clause is no longer valid. | Optional | 65.0 | | insurance​Product​ClauseId | String | ID of the insurance product clause. | Optional | 65.0 | # Insurance Product Discovery Validation Input Input representation of the product to validate for discovery setup. Identify the product by ID, product code, or developer name. ## JSON Example { "productId": "01txx0000006iPnAAI" } ## Properties Specify at least one of productId, productCode, or productName. If none is provided, validation fails with error code SF-INS-DSAV-00038. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productCode | String | Product code used to look up the insurance product to validate for discovery setup. | Required if productId and productName aren’t specified | 68.0 | | productId | String | Product2 ID of the insurance product to validate for discovery setup. | Required if productCode and productName aren’t specified | 68.0 | | productName | String | Developer name used to look up the insurance product to validate for discovery setup. | Required if productId and productCode aren’t specified | 68.0 | # Insurance Product Discovery Validation Response Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages. ## JSON Example { "isValid": false, "errors": \[ { "code": "SF-INS-DSAV-00004", "message": "The product isn’t associated with a product selling model option. Associate the product with a product selling model option." }, { "code": "SF-INS-DSAV-00011", "message": "The product doesn’t have a price book entry. Create a price book entry for the product." } \], "infos": \[ { "code": "SF-INS-DSAV-00043", "message": "If you’ve recently made changes to decision tables used by product discovery, ensure they are refreshed." } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | Errors encountered during validation. This list includes request-level failures, such as a missing product identifier or a product that can’t be found, and discovery setup failures, such as a missing or inactive price book entry, selling model, pricing procedure, or decision table configuration. | Big, 68.0 | 68.0 | | infos | [Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm "Output representation of one validation diagnostic, including the error code and message.")\[\] | Informational messages about the validation context. For example, pricing procedure validation can be skipped when pricing is disabled for product discovery (SF-INS-DSAV-00042), and a reminder can indicate that decision tables may need a refresh (SF-INS-DSAV-00043). | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether the product discovery setup is valid (true) or not (false). This value is true when no errors are detected. | Big, 68.0 | 68.0 | # Insurance Product Hierarchy Validation Result Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check. ## JSON Example { "productId": "01txx0000006iPtAAI", "productName": "Vehicle", "errors": \[ { "code": "SF-INS-DSAV-00004", "message": "The product isn’t associated with a product selling model option. Associate the product with a product selling model option." }, { "code": "SF-INS-DSAV-00011", "message": "The product doesn’t have a price book entry. Create a price book entry for the product." } \], "infos": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm "Output representation of one validation diagnostic, including the error code and message.")\[\] | Validation errors found for this related product. Each entry includes an error code and a message that describes how to resolve the failure. | Big, 68.0 | 68.0 | | infos | [Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm "Output representation of one validation diagnostic, including the error code and message.")\[\] | Informational messages for this product. Each entry includes a code and a message. | Big, 68.0 | 68.0 | | productId | String | ID of the child product associated with the root insurance product identified by productId in the top-level response. | Big, 68.0 | 68.0 | | productName | String | Name of the child product. | Big, 68.0 | 68.0 | # Insurance Product Model Validation Input Input representation of the details to validate an insurance product model. ## JSON Example { "productId": "01txx0000006iPnAAI" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the root insurance product for which you want to validate the model setup. The API validates this product and all associated products in its hierarchy, including direct children, component groups, and classification-based children. | Required | 68.0 | # Insurance Product Model Validation Response Output representation of the validation results for a product model and its hierarchy. ## JSON Example { "errors": \[\], "isValid": false, "productId": "01txx0000006iPnAAI", "products": \[ { "errors": \[ { "code": "SF-INS-DSAV-00004", "message": "The product isn’t associated with a product selling model option. Associate the product with a product selling model option." }, { "code": "SF-INS-DSAV-00011", "message": "The product doesn’t have a price book entry. Create a price book entry for the product." } \], "productId": "01txx0000006iPtAAI", "productName": "Vehicle" } \], "infos": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | Request-level errors that aren’t specific to a product in the hierarchy, such as a missing or invalid productId, insufficient access, or an unexpected server error. This list is empty when per-product validation runs. Product-specific failures are returned in products. | Big, 68.0 | 68.0 | | infos | [Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm "Output representation of one validation diagnostic, including the error code and message.")\[\] | Informational messages for the root product. Each entry includes a code and a message. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether all products in the hierarchy passed validation (true) or not (false). | Big, 68.0 | 68.0 | | productId | String | ID of the insurance product that’s validated. | Big, 68.0 | 68.0 | | products | [Insurance Product Hierarchy Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_hierarchy_validation.htm "Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check.")\[\] | Related products in the root product hierarchy that have configuration errors. Each entry identifies a product and lists the validation failures for that product. | Big, 68.0 | 68.0 | # Insurance Product Rating (POST, PATCH) Rate products or update product ratings in insurance quoting processes. ## Resource /connect/insurance/product-rating ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-rating ## Available Version 63.0 ## HTTP Methods POST, PATCH ## Request Body for POST ### JSON Example { "transactionType": "AutoTransactionType", "additionalFields": { "QuoteAccount": "001ZM000002ZNnBYAW" }, "ratingOptions": { "executeConfigurationRules": false }, "ratingInputs": \[ { "productCode": "auto", "instanceKeys": \[ "Auto1" \], "attributes": { "Make": "BMW", "AutoValue": "20000", "Year": "2024", "Model": "SUV" } }, { "productCode": "comprehensive", "instanceKeys": \[ "Auto1", "Comprehensive" \], "attributes": { "Limit": "2000", "Deductible": "100" } } \], "rootProductCodes": \[ "auto-ECO1x", "auto-ECO2x" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Required if the generated context ID is used to issue a policy | 63.0 | | effectiveDate | String | Date used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 63.0 | | ratingInputs | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | JSON that contains the attribute values of each context node. | Required | 63.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.")\[\] | Options for rating. | Optional | 63.0 | | rootProductCodes | String \[\] | Root product codes that are used with the ratingInputs to create rating result. The created rating result is used as request in the insurance product rating API. | Optional | 66.0 | | transactionType | String | Name of the transaction processing type. | Required | 63.0 | ## Response Body for POST [Product Rating Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_rating_output.htm "Output representation for the Product Rating Connect API.") ## Request Body for PATCH ### JSON Example { "contextId": "a49103b233638b918217c74eced69220e534e160c3d3d35bc8cf6608515aeab3", "ratingOptions": { "executePricing": true, "executeConfigurationRules": false }, "updatedNodes": \[ { "instanceKeys": \[ "AutoSilver", "BMW", "Tim1" \], "productCode": "driver", "attributes": { "DriverAccidentPoints": 1, "AgeFirstLicensed": 50, "DriverMVRPoints": 1 }, "targetRecords": \[ "003DR000002ov8NYAQ", "001DR000003avQCYAY" \] } \], "addedNodes": \[ { "instanceKeys": \[ "AutoSilver", "Tesla" \], "productCode": "auto", "attributes": { "Year": "2022", "Model": "Y" } }, { "instanceKeys": \[ "AutoSilver", "Tesla", "collision1" \], "productCode": "collision", "attributes": { "Limit": 500, "Deductible": 1000 } }, { "instanceKeys": \[ "AutoSilver", "Tesla", "Driver1" \], "productCode": "driver", "attributes": { "DriverAccidentPoints": 5, "AgeFirstLicensed": 30, "DriverMVRPoints": 1 }, "targetRecords": \[ "003DR000002oxCfYAI", "001DR000003azdpYAA" \] }, { "instanceKeys": \[ "AutoSilver", "Audi", "Collision2" \], "productCode": "collision", "attributes": { "Limit": 500, "Deductible": 1000 } } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of added nodes. | Optional | 63.0 | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Optional | 63.0 | | contextId | String | Context ID. | Required | 63.0 | | deletedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of deleted nodes. | Optional | 63.0 | | effectiveDate | String | Date used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 63.0 | | ratingDate | String | Date that's used to find the active pricing procedure. | Optional | 63.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.")\[\] | Options for rating. | Optional | 63.0 | | updatedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of updated nodes. | Optional | 63.0 | ## Response Body for PATCH [Product Rating Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_rating_output.htm "Output representation for the Product Rating Connect API.") # Insurance Product Rating Details (POST) Generate rating input details from a list of Product IDs, and use the generated rating input as the request body for the Insurance Product Rating API to evaluate product pricing. This API retrieves product catalog information and constructs a hierarchical rating input structure based on product relationships. It generates product-specific attributes that's formatted specifically for the [Insurance Product Rating API](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm "HTML (New Window)"). ## Resource /connect/insurance/product-rating/get-rating-input ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-rating/get-rating-input ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productIds": \[ "01txx0000006i3DAAQ" \], "salesTransactionTypeId": "0YWxx000000001GAAQ", "transactionType": "Auto", "ratingOptions": { "executeConfigurationRules": true, "executePricing": true, "returnContextJSON": false, "returnProductDetails": false }, "effectiveDate": "2025-01-01T00:00:00.000Z", "ratingDate": "2025-01-01T00:00:00.000Z", "additionalFields": { "customField1": "value1" }, "rootProductCodes": \[ "AUTO\_POLICY" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Additional fields to generate rating input. | Optional | 66.0 | | effectiveDate | Date | Date that's used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 66.0 | | productIds | String\[\] | IDs of the products for which you want to generate rating input. | Required | 66.0 | | ratingDate | Date | Date that's used to calculate rating. | Optional | 66.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.") | Options to control rating behavior. | Optional | 66.0 | | rootProduct​Codes | String\[\] | Root product codes that are used to create rating inputs. | Optional | 66.0 | | salesTransaction​TypeId | String | ID of the sales transaction type for which you want to generate rating request payload. | Optional | 66.0 | | transaction​Type | String | Name of the transaction processing type. | Optional | 66.0 | ## Response Body for POST [Product Rating Details Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_rating_details_output.htm "Output representation that contains the constructed rating request payload.") # Insurance Product Surcharge (PATCH) Update or fetch a product surcharge for a root product. ## Resource {productSurchargeId} is a placeholder. /connect/insurance/product-surcharges/{productSurchargeId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. {productSurchargeId} is a placeholder. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-surcharges/{productSurchargeId} ## Available Version 63.0 ## HTTP Methods PATCH ## Request Body for PATCH ### JSON Example { "name": "AutoVehicleTax", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "isProrationEligible": true, "isRefundEligible": true, "isActive": true, "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "ruleDefinition": \[ // ruleDefinition will be replaced as a whole. Updating only one condition is not supported { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : "", "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : "", "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], "sequenceNumber": 0 } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveFromDate | String | Effective from date of the product surcharge. | Optional | 63.0 | | effectiveToDate | String | Effective to date of the product surcharge. | Optional | 63.0 | | isActive | Boolean | Indicates whether the product surcharge is active (true) or not ( false). Currently, only active product surcharges are supported. | Optional | 63.0 | | isProrationAllowed | Boolean | Indicates whether the product surcharge is allowed for proration (true) or not (false). | Optional | 63.0 | | isRefundAllowed | Boolean | Indicates whether the product surcharge is allowed for refund (true) or not (false). | Optional | 63.0 | | name | String | Name of the product surcharge. | Optional | 63.0 | | productPath | String | A path containing the product IDs that roll up to the parent product. | Optional | 63.0 | | productRelatedComponentId | String | Product related component associated with the product surcharge. | Optional | 63.0 | | ruleApiName | String | Rule API name associated with product surcharge. You can set the ruleApiName with the POST or PATCH method. Once set, this parameter can’t be changed. If you set the ruleApiName in the request body, you must also set the ruleCriteria. | Optional | 63.0 | | ruleCriteria | [Insurance Rule Criteria Input\[\]](connect_requests_insurance_rule_criteria_input.htm "Input representation details of the insurance rule criteria.") | Rule criteria for the dynamic rule. | Optional | 63.0 | | sequenceNumber | Integer | Order in which surcharges are calculated when multiple surcharges are applied to a product. | Optional | 67.0 | ## Response Body for PATCH [Product Surcharge Patch](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_surcharge_patch_output.htm "Output representation of product surcharge update.") # Insurance Product Surcharge Bulk (POST) Create one or more product surcharges to associate with a root product. ## Resource /connect/insurance/product-surcharges/bulk ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/product-surcharges/bulk ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "records": \[ { "name": "AutoVehicleTax", "surchargeId": "01cLO000000EMslOKL", "rootProductId": "01tDR000000EMslYAG", "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "isProrationEligible": true, "isRefundEligible": true, "isActive": true, "ruleApiName": "autoVehicleTaxRule", "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", "productRelatedComponent": "", "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", "productRelatedComponent": "", "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" \] } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | records | [Product Surcharge Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_surcharge_post_input.htm "Input representation of product surcharge details.")\[\] | List of the product surcharges. | Required | 63.0 | ## Response Body for POST [Product Surcharge List](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_surcharge_list_output.htm "Output Representation for List of ProductSurcharge") # Insurance Quote Output representation of the details of the insurance quote. ## JSON Example { "quoteId" : "0Q0xx0000004E2mCAE", "contextId" : "98977d60d58a614485280fe430afded87290baa9a6ad6bfec889df75ef11008e" "errors" : \[\], "success" : true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | configMessages | [Insurance Configurator Message](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_config_message_output.htm "Output representation of configurator messages.")\[\] | List of insurance quote configurator messages. | Small, 63.0 | 63.0 | | contextId | String | ID of the context. | Small, 63.0 | 63.0 | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.252.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)") | List of errors encountered during the processing of the API request. | Small, 63.0 | 63.0 | | quoteDetails | Map | Details of the insurance quote. | Small, 63.0 | 63.0 | | quoteId | String | ID of the quote. | Small, 63.0 | 63.0 | | success | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Small, 63.0 | 63.0 | # Insurance Quote (POST) Generate a quote or quote-ready context in multiple ways. The API accepts user inputs, generates context, runs rules and pricing, prorates, and then returns a quote ID. The API can also use a context ID to run pricing and rules, update the context, and then return a quote ID. Alternatively, the API can accept user inputs, generate context, run rules and pricing, prorate, and then return only the context ID. ## Resource /connect/insurance/quotes ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteName": "Auto Insurance Quote", "effectiveDate": "2024-06-30T00:00:00.000Z", "expirationDate": "2025-07-28T00:00:00.000Z", "opportunityId": "006xx000001a2odAAA", "transactionType": "AutoTransactionType", "salesTransactionTypeId": "1Chxx0000004C92CAE", "priceBookId": "01sxx0000005ptpAAA", "configOptions": { "executePricing": false, "validateProductCatalog": false, "executeConfigurationRules": false, "executeQualificationRules": false }, "options": { "saveQuote": true, "productSellingModel": "One Time" }, "quoteInputs": \[ { "productCode": "autoRoot", "instanceKeys": \[ "AutoRoot" \], "items": \[ { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle1" \], "attributes": { "avMake": "BMW", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoComp", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoComp" \], "attributes": { "CompBasePremium": "750" } }, { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle2" \], "attributes": { "avMake": "Audi", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoCollision", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoCollision1" \], "attributes": { "CollisionBasePremium": "120" } } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the account associated with the quote that’s being created. | Optional | 63.0 | | additionalFields | Map | Additional fields that are used to create insurance quote. | Optional | 63.0 | | configOptions | [Insurance Quote Config Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_config_options.htm "Input representation of insurance quote line item related objects.") \[\] | The JSON structure that includes the options for configuration. | Optional | 63.0 | | contextId | String | ID of the context that’s used for creating the quote. | Optional | 63.0 | | effectiveDate | String | Date that the quote is effective from. | Required | 63.0 | | expirationDate | String | Expiration date of the quote. | Optional | 63.0 | | opportunityId | String | ID of the opportunity associated with the quote. | Optional | 63.0 | | options | [Insurance Quote Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_options.htm "Input representation of insurance quote options.")\[\] | Insurance Quote Options. | Optional | 63.0 | | priceBookId | String | ID of the pricebook associated with the quote. | Optional | 63.0 | | pricingProcedure | String | Pricing Procedure for insurance quote. | Optional | 63.0 | | quoteInputs | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | The JSON structure that contains user inputs for the products for which the quote is being created. | Required | 63.0 | | quoteName | String | Name of the quote. | Optional | 63.0 | | ratingDate | String | Date of the rating quote. | Optional | 63.0 | | salesTransactionTypeId | String | ID of the sales transaction type. | Optional | 63.0 | | transactionType | String | Type of the transaction. | Optional | 63.0 | ## Response Body for POST [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_quote_output.htm "Output representation of the details of the insurance quote.") # Insurance Quote Config Options Input representation of insurance quote line item related objects. ## JSON Example "configOptions": { "executePricing": false, "validateProductCatalog": false, "executeConfigurationRules": false, "executeQualificationRules": false } ## Properties
Name Type Description Required or Optional Available Version
executeConfigurationRules Boolean Indicates whether to run product configuration rules as part of insurance quote (true) or not (false). Optional 63.0
executePricing Boolean Indicates whether to execute NGP Pricing as part of insurance quote (true) or not (false).

This parameter is always set to false for Group Benefits rating.

 Optional 63.0
executeQualificationRules Boolean Indicates whether to execute qualification rules as part of insurance quote (true) or not (false). Optional 63.0
validateProductCatalog Boolean Indicates whether to execute product catalog validation as part of insurance quote (true) or not (false). Optional 63.0
# Insurance Quote Configuration Options Input Input representation of the details to specify whether configuration and qualification rules run when creating a quote from a contract. ## JSON Example { "executeConfigurationRules": true, "executeQualificationRules": true } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | executeConfigurationRules | Boolean | Indicates whether to run configuration rules when creating the quote (true) or not (false). | Optional | 68.0 | | executeQualificationRules | Boolean | Indicates whether to run qualification rules when creating the quote (true) or not (false). | Optional | 68.0 | # Insurance Quote Details (GET, PATCH) Get or update quote details by the specified quote ID. You can get the desired quote details by using the filter and non-filter request parameters. Use the term filter to differentiate between the filter and non-filter parameters. See, Resource example. ![Note](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/images/icon_note.png) #### Note A filter parameter is used to show the results that match a certain criteria, for example ProductSpec=InsuredItem shows the quote details for the insured item only. A non-filter parameter controls the behavior or format of the response, for example returnChildrenNodes=true shows the child nodes of the SalesTransactionItem. In the default context definition, a SalesTransactionItem in context represents a QuoteLineItem. These are the operators that are supported to filter the results. - eq—Equal - ne—Not equal - lt—Less than - lte—Less than or equal to - gt—Greater than - gte—Greater than or equal to ## Resource {quoteId} is a placeholder. /connect/insurance/quotes/{quoteId} /connect/insurance/quotes/{quoteId}?contextId=\[value\]filter\[field1\]\[operator1\]=\[value1\]&filter\[field2\]\[operator2\]=\[value2\]&key1=value1&includeClause=true The field1 parameter refers to the ProductSpec filter parameter, and the field2 parameter refers to the valid context attribute of SalesTransactionItem in the target context definition. You can add multiple filter and non-filter parameters to get the desired result. ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes/0Q0DR0000000xFw0AI https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes/0Q0DR0000000xFw0AI?contextId=0000000i18tq18g002917545349255616564529f415d45c4b1b1ea08747a2195&filter\[ProductSpec\]\[eq\]=InsuredItem&filter\[DYN\_\_Auto\_Value\]\[gt\]=60000&returnChildrenNodes=true&includeClause=true ## Available Version 63.0 ## HTTP Methods GET, PATCH ## Request Parameters for GET
Parameter Name Type Description Required or Optional Available Version
connectDynamicParameters Map<String,String>

Specify these filter and non-filter request parameters to get the desired results.

  • contextId—Non-filter parameter to get the quote details for the specified context ID.
  • ProductSpec—Filter parameter to get the quote details for the specified product spec. Valid values are:
    • Coverage
    • InsuredItem
    • InsuredParty
    • Product
  • returnChildrenNodes—Non-filter parameter that retrieves all the SalesTransactionItems in the hierarchy, starting from each matching SalesTransactionItem and includes all child nodes.

    Use the returnChildrenNodes parameter with filter parameters.

  • includeClause—Non-filter parameter that includes the associated product clauses of the SalesTransactionItems in the response body.

    Use the includeClause parameter with filter parameters.

 Optional 63.0
## Response Body for GET [Get Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_quote_output.htm "Output representation of the details of the get quote details.") ## Request Body for PATCH ### JSON Example { "configOptions": { "executePricing": false, "validateProductCatalog": false, "executeConfigurationRules": false, "executeQualificationRules": false }, "additionalFields": { "Status": "Draft", "ValidFromDate": "2025-10-29T00:00:00.000Z" }, "addedNodes": \[ { "productCode": "autoCollision", "instanceKeys": \[ "autoBundle", "autoCollision" \], "additionalFields": { "StartDate": "2025-09-29T00:00:00.000Z", "EndDate": "2025-10-29T00:00:00.000Z", "Discount": 40 } } \], "updatedNodes": \[ { "instanceKeys": \[ "autoBundle" \], "productCode": "autoBundle", "attributes": { "avMake": "AudiQ14" }, "additionalFields": { "StartDate": "2025-09-29T00:00:00.000Z", "EndDate": "2025-10-29T00:00:00.000Z", "Discount": 50 } } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of added nodes for insurance quote. | Optional | 63.0 | | additionalFields | Map | Insurance quote additional fields. | Optional | 63.0 | | configOptions | [Insurance Quote Config Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_config_options.htm "Input representation of insurance quote line item related objects.") \[\] | Configurator options for insurance quote. | Optional | 63.0 | | deletedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of deleted nodes from insurance quote. | Optional | 63.0 | | pricingProcedure | String | Pricing procedure for insurance quote. | Optional | 63.0 | | updatedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of updated nodes on insurance quote. | Optional | 63.0 | ## Response Body for PATCH [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_quote_output.htm "Output representation of the details of the insurance quote.") # Insurance Quote Input Node Input representation of root quote line items and child quote line items of insurance quote. ## JSON Example quoteInputs: \[ { "productCode": "autoRoot", "instanceKeys": \[ "AutoRoot" \], "items": \[ { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle1" \], "attributes": { "avMake": "BMW", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoComp", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoComp" \], "attributes": { "CompBasePremium": "750" } }, { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle2" \], "attributes": { "avMake": "Audi", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoCollision", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoCollision1" \], "attributes": { "CollisionBasePremium": "120" } } \] } \] ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Insurance quote line items. | Optional | 63.0 | | attributes | Map | Insurance quote attributes key-value pairs. | Optional | 63.0 | | instanceKeys | String\[\] | Product instance identifier of the quote line item. | Required | 63.0 | | items | String\[\] | The JSON structure that contains user inputs for the products for which the quote is created. | Optional | 63.0 | | priceBookEntryId | String | ID of the pricebook associated with the quote. | Optional | 63.0 | | productCode | String | Product code of the associated product. | Required | 63.0 | | relatedRecords | [Insurance Quote Related Record Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_related_record_input.htm "Input representation of insurance quote line item related objects.")\[\] | List of the related insurance quote records. | Required | 62.0 | # Insurance Quote Item Input Input representation of the details to extend the quote created from a contract. ## JSON Example { "entity": "Quote", "productPath": "Root", "fields": { "data": \[ { "key": "StandardAmount", "value": "80" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | entity | String | API name of the entity that receives the additional field values, such as Quote. | Optional | 68.0 | | fields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | List of key-value pairs that represent the fields and their values for the entity. | Optional | 68.0 | | productPath | String | Product path that identifies where in the quote structure the additional fields apply. | Optional | 68.0 | # Insurance Quote Options Input representation of insurance quote options. ## JSON Example options: { "saveQuote": true, "productSellingModel": "One Time" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productSellingModel | String | Determines the pricebookId for the products. | Required | 63.0 | | saveQuote | Boolean | Indicates whether to save insurance quote or only generate context. | Required | 63.0 | # Insurance Quote Patch Input Input representation for insurance quote patch operation. ## JSON Example { "configOptions": { "executePricing": false, "validateProductCatalog": false, "executeConfigurationRules": false, "executeQualificationRules": false }, "additionalFields": { "Status": "Draft", "ValidFromDate": "2025-10-29T00:00:00.000Z" }, "addedNodes": \[ { "productCode": "autoCollision", "instanceKeys": \[ "autoBundle", "autoCollision" \], "additionalFields": { "StartDate": "2025-09-29T00:00:00.000Z", "EndDate": "2025-10-29T00:00:00.000Z", "Discount": 40 } } \], "updatedNodes": \[ { "instanceKeys": \[ "autoBundle" \], "productCode": "autoBundle", "attributes": { "avMake": "AudiQ14" }, "additionalFields": { "StartDate": "2025-09-29T00:00:00.000Z", "EndDate": "2025-10-29T00:00:00.000Z", "Discount": 50 } } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of added nodes for insurance quote. | Optional | 63.0 | | additionalFields | Map | Insurance quote additional fields. | Optional | 63.0 | | configOptions | [Insurance Quote Config Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_config_options.htm "Input representation of insurance quote line item related objects.")\[\] | Configurator options for insurance quote. | Optional | 63.0 | | deletedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of deleted nodes from insurance quote. | Optional | 63.0 | | pricingProcedure | String | Pricing procedure for insurance quote. | Optional | 63.0 | | updatedNodes | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | List of updated nodes on insurance quote. | Optional | 63.0 | # Insurance Quote Post Input Input representation details to create insurance quote. ## JSON Example { "quoteName": "Auto Insurance Quote", "effectiveDate": "2024-06-30T00:00:00.000Z", "expirationDate": "2025-07-28T00:00:00.000Z", "opportunityId": "006xx000001a2odAAA", "transactionType": "AutoTransactionType", "salesTransactionTypeId": "1Chxx0000004C92CAE", "priceBookId": "01sxx0000005ptpAAA", "configOptions": { "executePricing": false, "validateProductCatalog": false, "executeConfigurationRules": false, "executeQualificationRules": false }, "options": { "saveQuote": true, "productSellingModel": "One Time" }, "quoteInputs": \[ { "productCode": "autoRoot", "instanceKeys": \[ "AutoRoot" \], "items": \[ { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle1" \], "attributes": { "avMake": "BMW", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoComp", "instanceKeys": \[ "AutoRoot", "AutoBundle1", "AutoComp" \], "attributes": { "CompBasePremium": "750" } }, { "productCode": "autoBundle", "instanceKeys": \[ "AutoRoot", "AutoBundle2" \], "attributes": { "avMake": "Audi", "avValue": "20000", "avYear": "2020", "AutoValueFactor": 5, "AutoAgeFactor": 6 } }, { "productCode": "autoDriver", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoDriver" \], "relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] }, { "productCode": "autoCollision", "instanceKeys": \[ "AutoRoot", "AutoBundle2", "AutoCollision1" \], "attributes": { "CollisionBasePremium": "120" } } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | ID of the account associated with the quote that’s being created. | Optional | 63.0 | | additionalFields | Map | Additional fields that are used to create insurance quote. | Optional | 63.0 | | configOptions | [Insurance Quote Config Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_config_options.htm "Input representation of insurance quote line item related objects.")\[\] | The JSON structure that includes the options for configuration. | Optional | 63.0 | | contextId | String | ID of the context that’s used for creating the quote. | Optional | 63.0 | | effectiveDate | String | Date that the quote is effective from. | Required | 63.0 | | expirationDate | String | Expiration date of the quote. | Optional | 63.0 | | opportunityId | String | ID of the opportunity associated with the quote. | Optional | 63.0 | | options | [Insurance Quote Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_options.htm "Input representation of insurance quote options.")\[\] | Insurance Quote Options. | Optional | 63.0 | | priceBookId | String | ID of the pricebook associated with the quote. | Optional | 63.0 | | pricingProcedure | String | Pricing Procedure for insurance quote. | Optional | 63.0 | | quoteInputs | [Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm "Input representation of root quote line items and child quote line items of insurance quote.")\[\] | The JSON structure that contains user inputs for the products for which the quote is being created. | Required | 63.0 | | quoteName | String | Name of the quote. | Optional | 63.0 | | ratingDate | String | Date of the rating quote. | Optional | 63.0 | | salesTransactionTypeId | String | ID of the sales transaction type. | Optional | 63.0 | | transactionType | String | Type of the transaction. | Optional | 63.0 | # Insurance Quote Related Record Input Input representation of insurance quote line item related objects. ## JSON Example relatedRecords": \[ { "relatedRecordId": "001xx000003GYiEAAW", "relatedRecordObjName": "Account" }, { "relatedRecordId": "001xx000003GYiEAAV", "relatedRecordObjName": "Contact" } \] ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | relatedRecordId | String | ID of the related insurance quote record. | Required | 63.0 | | relatedRecordObjName | String | Object API name of the related insurance quote record. | Required | 63.0 | # Insurance Quoting Use the Insurance Quoting developer resources to create, update, configure, and delete quotes and quote line items.
Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions
- **[Insurance Quoting Business APIs](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_business_api_overview.htm)** Create, update, configure, and delete quotes and quote line items. Use the APIs to create guided flows for your external end users. - **[Insurance Quoting Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_invocable_actions_parent.htm)** Learn more about the standard invocable actions available with Insurance Quoting. - **[Insurance Quoting Metadata API Types](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_quoting_metadata_api_parent.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. - **[Insurance Quoting Developer Journey](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_quoting_developer_journey.htm)** Learn how to use the Insurance Quoting and Rating APIs to build user journeys for creating and updating quotes with Salesforce Flows and Omniscripts. These APIs help you build user journeys for users, such as insurance representatives who use the Salesforce console as well as the policyholders and partners who use the services through community portals. #### See Also - [_Salesforce Help_: Insurance Quoting](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/quote_overview.htm) # Insurance Quoting Business APIs Create, update, configure, and delete quotes and quote line items. Use the APIs to create guided flows for your external end users. This table lists the available Insurance Quoting resources. | Resource | Description | | --- | --- | | [/connect/insurance/quotes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "Generate a quote or quote-ready context in multiple ways. The API accepts user inputs, generates context, runs rules and pricing, prorates, and then returns a quote ID. The API can also use a context ID to run pricing and rules, update the context, and then return a quote ID. Alternatively, the API can accept user inputs, generate context, run rules and pricing, prorate, and then return only the context ID.") (POST) | Generate a quote or quote-ready context in multiple ways. | | [/connect/insurance/product-rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm "Rate products or update product ratings in insurance quoting processes.") (POST, PATCH) | Rate products or update product ratings for use in Insurance quoting processes. | | [/connect/insurance/product-rating/get-rating-input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_rating_get_rating_details.htm "Generate rating input details from a list of Product IDs, and use the generated rating input as the request body for the Insurance Product Rating API to evaluate product pricing.") (POST) | Generate rating input details from a list of Product IDs, and use the generated rating input as the request body for the Insurance Product Rating API to evaluate product pricing. | | [/connect/insurance/product-surcharges/productSurchargeId](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_surcharge.htm "Update or fetch a product surcharge for a root product.") (PATCH) | Update or fetch a product surcharge for a root product. | | [/connect/insurance/product-surcharges/bulk](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_surcharge_bulk.htm "Create one or more product surcharges to associate with a root product.") (POST) | Create one or more product surcharges to associate with a root product. | | [/connect/insurance/quotes/quoteId](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "Get or update quote details by the specified quote ID.") (GET, PATCH) | Update or get details for a specified quote ID. | | [/connect/insurance/underwriting-rules/invoke](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "Get or update quote details by the specified quote ID.") (POST) | Invoke underwriting rules for different object records during run time. | | [/connect/insurance/product-clauses/add-eligible-product-clauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_add_eligible_product_clauses.htm "Add selected eligible product clauses to a quote or context.") (POST) | Add selected eligible product clauses to a quote or context. | | [/connect/insurance/product-clauses/eligible-product-clauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_eligible_product_clauses.htm "Get eligible product clauses based on quoteId and contextId.") (POST) | Get eligible product clauses based on quoteId and contextId. | | [/connect/insurance/product-clauses/productClauseId](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clause_update.htm "Update an existing product clause for a root product.") (PATCH) | Update an existing product clause for a root product. | | [/connect/insurance/product-clauses/bulk](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clauses_bulk_create.htm "Create one or multiple product clauses at once.") (POST) | Create one or multiple product clauses at once. | | [/connect/insurance/product-clauses/clause-generation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clauses_generate.htm "Generate product clauses based on quote and context information.") (POST) | Generate product clauses based on quote and context information. | - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_business_apis_resources.htm)** Learn more about the available Insurance Quoting API resources. - **[Requests](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_business_apis_requests.htm)** Learn more about the available Insurance Quoting requests. - **[Responses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_business_apis_responses.htm)** Learn more about the available response bodies of Insurance Quoting APIs. # Insurance Quoting Developer Journey Learn how to use the Insurance Quoting and Rating APIs to build user journeys for creating and updating quotes with Salesforce Flows and Omniscripts. These APIs help you build user journeys for users, such as insurance representatives who use the Salesforce console as well as the policyholders and partners who use the services through community portals. Refer to these use cases to deepen your knowledge about these user journeys. - **[Build a Self-service Quote and Policy Creation Functionality for Community Portal Users](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/self_service_quote_and_policy_creation.htm)** This user journey applies when a user, such as a policyholder or partner, logs into a customer community portal to select a product, view its price, and configure its attributes. The user then creates a quote, and proceeds to issue a policy. - **[Calculate Quote Price Without Creating a Formal Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/generate_price_estimates_without_saving_quote.htm)** This user journey applies when a customer wants to see an estimated quote price based on their requirements without having to save a formal quote. - **[Implement Quote Creation Functionality for Insurance Representatives](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_creation_for_internal_agents.htm)** This user journey applies when a policyholder contacts an insurance company and an insurance representative guides them through identifying coverage needs, configuring and pricing a quote, and sharing it for review. - **[Implement Quote Update Functionality for Insurance Representatives](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/quote_update_for_internal_agents.htm)** This user journey applies when a policyholder wants to update an existing quote, such as adding, deleting, or editing quote line items. # Insurance Quoting Errors Contains the error codes and error code messages that are applicable to the Insurance Quoting APIs. | Error Code | HTTP Response Code | Message | | --- | --- | --- | | SF-0002-0001 | 400 | For the contextId and quoteInputs parameters, specify a value and try again. | | SF-0002-0002 | 400 | Specify the relatedRecordId and relatedRecordObjName parameters in the relatedRecords array and try again. | | SF-0002-0003 | 400 | More than one related record mapping found for {entityName}. Ensure that you specify only one related record mapping for {entityName} and try again. | | SF-0002-0004 | 400 | {attributeList} not found for product {productCode}. Specify supported values for the attributes object and try again. | | SF-0002-0005 | 400 | Values of the instance key arrays are not unique {instanceKey}. Specify unique instance key arrays and try again. | | SF-0002-0006 | 400 | More than one instance key array found {instanceKey}. Specify unique instance key arrays and try again. | | SF-0002-0007 | 400 | Value {inputValue} is invalid for {inputField}. Specify unique values for the instance key array and try again. | | SF-0002-0008 | 400 | The instance {instanceKey} you are trying to delete doesn't exist. | | SF-0002-0009 | 400 | The instance {instanceKey} you are trying to update doesn't exist. | | SF-0002-0010 | 400 | Specify the configuration parameters in the configOptions object and try again. | | SF-0002-0011 | 400 | Product with product code {productCode} failed the qualification criteria. Specify a valid product and try again. | | SF-0002-0012 | 400 | The {instanceKey} instance key has conflicting values for attributes or relatedRecords. Specify identical values and try again. | # Insurance Quoting Metadata API Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. The following list links to Metadata API types used in Insurance Quoting. - [Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm) Represents the metadata associated with a flow, including its structure, logic, and run-time behavior. - [Flow for Insurance Quoting](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/insurance_quoting_flow_metadata_api.htm "Represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications.") Insurance Quoting exposes additional actionType values for the FlowActionCall Metadata type. # Insurance Quoting Standard Invocable Actions Learn more about the standard invocable actions available with Insurance Quoting. - **[Add Eligible Insurance Clauses Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_add_eligible_insurance_clauses.htm)** Add eligible insurance clauses to a quote or context. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID along with insurance product clause details. - **[Create Insurance Quote Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm)** Create an Insurance quote by using a context ID or a set of user inputs that represent quote details. - **[Create Insurance Rating Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_insurance_rating.htm)** Create a runtime context that contains the details to create a quote. - **[Generate Insurance Clauses Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_generate_insurance_clauses.htm)** Generate insurance clauses based on the specified quote and context information. You must specify either quote ID or context ID to generate insurance clauses. - **[Get Eligible Insurance Clauses Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_eligible_insurance_clauses.htm)** Get eligible insurance clauses based on quote ID and context ID. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID to get the eligible insurance clauses. - **[Get Insurance Quote Details Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_quote_details.htm)** Get the details of an insurance quote. - **[Get Insurance Rating Input Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_rating_input.htm)** Get the rating input data for the insurance products to support the pricing calculations and coverage analysis. - **[Reprice Insurance Product Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_reprice_insurance_product.htm)** Recalculate the price of insurance products based on user inputs. - **[Update Insurance Quote Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_insurance_quote.htm)** Update an existing insurance quote by adding, updating, or deleting nodes and optionally executing pricing and rules. # Insurance Request Validation Input Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model. ## JSON Example { "apiPath": "insurance/quotes", "requestBody": "{"quoteLineItems":\[{"productCode":"AUTO\_POLICY","attributes":\[{"attributeCode":"DRIVER\_AGE","value":"25"},{"attributeCode":"INVALID\_ATTR","value":"X"}\],"childProducts":\[{"productCode":"COLLISION\_COVERAGE"}\]}\]}" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiPath | String | Path of the insurance Connect API request to validate. Supported values are insurance/quotes and insurance/product-rating. Requests for unsupported API paths return a valid response with an informational message. | Required | 68.0 | | requestBody | String | Serialized JSON string to validate. The API parses the data and checks product codes, attributes, hierarchy, and instance keys against the org’s product model. The string must be valid JSON. | Required | 68.0 | # Insurance Request Validation Response Response representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation. ## JSON Example { "isValid": false, "results": \[ { "isValid": false, "code": null, "instructions": "Attribute code 'INVALID\_ATTR' is not defined in the attribute definitions." } \], "errors": \[\] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm "Output representation of a top-level error returned before per-attribute validation runs.")\[\] | List of request-level errors that prevented validation from being performed, such as a missing required input value. Empty or absent when validation runs normally. | Big, 68.0 | 68.0 | | isValid | Boolean | Overall validation status. Returns true when no validation issues are found; otherwise returns false. | Big, 68.0 | 68.0 | | results | [Insurance Request Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_request_validation_result.htm "Response representation of a single request validation finding. When the finding isn’t valid, instructions describes the issue and how to resolve it.")\[\] | List of validation findings generated during request validation. Each finding describes a detected issue or informational message. | Big, 68.0 | 68.0 | # Insurance Request Validation Result Response representation of a single request validation finding. When the finding isn’t valid, instructions describes the issue and how to resolve it. ## JSON Example { "isValid": false, "code": null, "instructions": "Attribute code 'INVALID\_ATTR' is not defined in the attribute definitions." } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Stable error code that identifies the validation finding. Null for informational or valid findings. | Big, 68.0 | 68.0 | | instructions | String | Description of the validation finding. When isValid is false, this property includes guidance for resolving the issue. For valid or informational findings, this property can describe context such as an unsupported API path. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether this finding passed validation (true) or not (false). When false, see instructions for the failure reason and correction. | Big, 68.0 | 68.0 | # Insurance Rule Condition Input Input representation details of insurance rule condition. ## JSON Example "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \] ## Properties
Name Type Description Required or Optional Available Version
attributeId String ID of the attribute. Required 63.0
attributeName String Name of the attribute. Required 63.0
attributePicklistValueId String ID of the attribute picklist value. Required 63.0
conditionIndex Integer Index of the rule condition. Required 63.0
contextTagName String Tag name of the context. Required 63.0
dataType String Data type of the attribute. Required 63.0
operator String Type of operator. Possible values are:
  • Equals
  • LessThan
 Required 63.0
type String Type of rule condition. Required 63.0
values String[] List of values. Required 63.0
# Insurance Rule Criteria Input Input representation details of the insurance rule criteria. ## JSON Example "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \] ## Properties
Name Type Description Required or Optional Available Version
conditions Insurance Rule Condition Input[] List of rule conditions. Optional 63.0
criteriaIndex Integer Index of the rule criteria. Required 63.0
rootObjectId String ID of the root object. Required 63.0
sourceContextTagName String Name of the source context tag. Required 63.0
sourceDataType String Source data type. Possible values are:
  • String
  • Integer
 Required 63.0
sourceOperator String Source operator. Possible value:
  • Equals
 Required 63.0
sourceValues String[] List of source values. Required 63.0
# Insurance Sales Transaction Output representation for the insurance sales transaction. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | appUsageAssignments | [Insurance App Usage Assignment](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_app_usage_assignment_output.htm "Output representation for the insurance app usage assignment.")\[\] | Application context for a sales transaction record. | Small, 66.0 | 66.0 | | fields | Map | A key-value map that represents sales transaction record. | Small, 66.0 | 66.0 | | salesTransactionItems | [Insurance Sales Transaction Items](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_output.htm "Output representation for the insurance sales transaction item.")\[\] | List of individual line items that are associated with the sales transaction. In the default context definition, a sales transaction item represents a quote line item. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Output representation for the insurance sales transaction item. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | childNodes | [Insurance Sales Transaction Item](# "Output representation for the insurance sales transaction item.")\[\] | List of child sales transaction items. | Small, 66.0 | 66.0 | | fields | Map | A key-value map that represents sales transaction item record. | Small, 66.0 | 66.0 | | salesTransactionItemAttributes | [Insurance Sales Transaction Item Attribute](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_a_output.htm "Output representation for the details of the insurance sales transaction item attribute.")\[\] | List of dynamic attributes of the sales transaction item in key-value pairs. | Small, 66.0 | 66.0 | | salesTransactionItemClauses | [Insurance Sales Transaction Item Clause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_clause_output.htm "Output representation for the details of the insurance sales transaction item clause.")\[\] | List of clauses of the sales transaction item in key-value pairs. | Small, 66.0 | 66.0 | | salesTransactionItemRelatedObjects | [Insurance Sales Transaction Item Related Object](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_r_o_output.htm "Output representation for the details of the Insurance Sales Transaction Item Related Object.")\[\] | List of related objects of the sales transaction item in key-value pairs. | Small, 66.0 | 66.0 | | salesTransactionItemRelationships | [Insurance Sales Transaction Item Relationship](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_relationship_output.htm "Output representation for the details of the Insurance Sales Transaction Item Relationship.")\[\] | List of records that represent the relationship between the sales transaction items. | Small, 66.0 | 66.0 | | salesTransactionItemTaxes | [Insurance Sales Transaction Item Tax](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_tax_output.htm "Output representation for the details of the Insurance Sales Transaction Item Tax.")\[\] | List of tax records of the sales transaction items. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Attribute Output representation for the details of the insurance sales transaction item attribute. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the dynamic attributes of the sales transaction item. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Clause Output representation for the details of the insurance sales transaction item clause. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the clauses of the sales transaction item. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Related Object Output representation for the details of the Insurance Sales Transaction Item Related Object. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the related objects of the sales transaction item. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Relationship Output representation for the details of the Insurance Sales Transaction Item Relationship. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the relationship between the sales transaction items. | Small, 66.0 | 66.0 | # Insurance Sales Transaction Item Tax Output representation for the details of the Insurance Sales Transaction Item Tax. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fields | Map | A key-value map that represents the tax record of the sales transaction item. | Small, 66.0 | 66.0 | # Insurance UI Treatments Output representation for the details of the insurance UI treatments. ## JSON Example This example shows a sample success response. { "uiTreatments": \[ { "details": { "attributeId": "0tjxx0000000007AAA", "stiId": "0QLxx0000004CU0GAM", "attributePicklistValueId": "0v6xx0000000005AAA" }, "uiTreatmentTarget": "Attribute\_Picklist\_Value", "uiTreatmentType": "Hide" }, { "details": { "stiId": "ref\_f0f2da7b\_c431\_482d\_bf4b\_599052f3a2e1" }, "uiTreatmentTarget": "Component", "uiTreatmentType": "Disable" } \] }
Property Name Type Description Filter Group and Version Available Version
details Map<String, String> Key-value pair that specifies the items to apply the rules on, which includes these details.
  • ID of the sales transaction item
  • ID of the attribute
  • ID of the attribute picklist value
 Small, 66.0 66.0
uiTreatmentTarget String Target of the UI treatment. Valid values are:
  • Component—Represents a product option or bundle component.
  • Quantity—Represents a quantity field.
  • Attribute—Represents a certain attribute of the product.
  • Attribute_Picklist_Value—Represents one of the picklist values of a product attribute.
Small, 66.0 66.0
uiTreatmentType String Type of UI treatment to be performed. Valid values are:
  • Hide—Hide the associated target.
  • Disable—Disable the associated target.
Small, 66.0 66.0
# Insurance Underwriting Rule Group Input Input representation details of the insurance underwriting rule group. ## JSON Example "underwritingRuleGroup": { "underwritingRuleGroupId": "1KQ000000MKJIK", // Optional, // if underwritingRuleGroupId exist, then use it as parent instead of create a new record. "stageTransitionId": "0jjDR00000000VGAAA", // State Transition id. "stageTransitionName": "Draft to Approved", "objectType": "Quote", "recordType": "--Master--", "fromStage": "Draft", "toStage": "Approved", "rootProductId": "01tDR000000EMslYAG" // Auto Gold. "criteriaExpression": "1" // Exmple "(1 AND 2) OR 3" if more than 1 rules. } ## Properties
Name Type Description Required or Optional Available Version
criteriaExpression String Criteria Expression for the underwriting rule group. For example, (1 AND 2) OR 3. Required 63.0
fromStage String Name of the stage the record is moving from. Optional 63.0
objectType String Object type for which the underwriting rule group is defined. Required 63.0
recordType String Record type associated with the object type for which the underwriting rule group is defined. Optional 63.0
rootProductId String ID of the root product. Required 63.0
ruleEngineType String Engine type to use for underwriting rules. Valid values are:
  • BusinessRuleEngine
  • ConstraintEngine—If set to ConstraintEngine, the response includes lineItemIds and lineItemDetails for which the rule evaluates successfully. If the rule evaluation fails, these fields are shown empty. See, Insurance Underwriting Rule Result.

The default value is BusinessRuleEngine.

 Optional 67.0
rulesetStatus String Status of the dynamic ruleset. Possible values are:
  • Active
  • Inactive
  • Draft
 Required 63.0
stageTransitionId String ID of the stage transition. Required 63.0
stageTransitionName String Name of the source stage transition. Optional 63.0
toStage String Name of the stage the record is moving to. Optional 63.0
underwritingRuleGroupId String ID of the underwriting rule group. Optional 63.0
# Insurance Underwriting Rule Group Status (PATCH) Update the status of an underwriting rule group. ## Resource {uwrGroupId} is a placeholder. /connect/insurance/underwriting-rule-group-status/{uwrGroupId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. {uwrGroupId} is a placeholder. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/underwriting-rule-group-status/{uwrGroupId} ## Available Version 63.0 ## HTTP Methods PATCH ## Request Body for PATCH ### JSON Example { "status": "Active" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | status | String | The status of the underwriting rule group. | Required | 63.0 | ## Response Body for PATCH [Insurance Underwriting Rule Group Update Status](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rule_group_update_status_output.htm "Output representation of insurance underwriting rule group update status request.") # Insurance Underwriting Rule Group Update Status Output representation of insurance underwriting rule group update status request. ## JSON Example { "success": "true", "underwritingRuleGroupId": "1KQxx0000004C92GAE" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | success | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Big, 63.0 | 63.0 | | underwritingRuleGroupId | String | ID of the underwriting rule group whose ruleset status is updated. | Big, 63.0 | 63.0 | # Insurance Underwriting Rule Group Update Status Input Input representation of the request to update insurance underwriting rule group status. ## JSON Example { "status": "Active" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | status | String | The status of the underwriting rule group. | Required | 63.0 | # Insurance Underwriting Rule Result Underwriting rule evaluation result. ## JSON Example This example shows a sample response. { "ruleResult": \[ { "evaluationFailureTaskGroup": "13oSG0000005odiYAA", "evaluationSuccessTaskGroup": "13oSG0000005odhYAA", "isSuccess": true, "lineItemDetails": \[ { "id": "0QLSG0000025JvK4AU", "productId": "01tSG000008KnvAYAS", "productInstanceIdentifier": "AutoSilver" } \], "lineItemIds": \[ "0QLSG0000025JvK4AU" \], "ruleApiName": "AutoSilverRoot" }, { "evaluationFailureTaskGroup": "13oSG0000005ofKYAQ", "evaluationSuccessTaskGroup": "13oSG0000005ofJYAQ", "isSuccess": false, "lineItemDetails": \[\], "lineItemIds": \[\], "ruleApiName": "AutoYearGT2020" } \] }
Property Name Type Description Filter Group and Version Available Version
evaluationFailureTaskGroup String Identifier for the fulfillment task group (FulfillmentStepDefinitionGroup) that runs when the rule result fails. The group defines follow-up tasks for the related fulfillment plan. Small, 67.0 67.0
evaluationSuccessTaskGroup String Identifier for the fulfillment task group (FulfillmentStepDefinitionGroup) that runs when the rule evaluates successfully. The group defines follow-up tasks for the related fulfillment plan. Small, 67.0 67.0
isSuccess Boolean Indicates whether the underwriting rule evaluated successfully ( true) or not ( false). If isSucess is true, details of the line items on which the rule evaluated successfully are shown. Small, 63.0 63.0
lineItemDetails Insurance Line Item Details [] Details of the line items are shown when isSuccess is true. Small, 67.0 67.0
lineItemIds String[] IDs of the line items on which the rule executed successfully. Line items on which the rule execution fails aren’t included in the response.

Applicable when ruleEngineType is ConstraintEngine.

Small, 67.0 67.0
ruleApiName String API name of the dynamic rule. Small, 63.0 63.0
# Insurance Underwriting Rules (PATCH) Update an existing underwriting rule for a root product. ## Resource {underwritingRuleId} is a placeholder. /connect/insurance/underwriting-rules/{underwritingRuleId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. {underwritingRuleId} is a placeholder. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/underwriting-rules/{underwritingRuleId} ## Available Version 63.0 ## HTTP Methods PATCH ## Request Body for PATCH ### JSON Example { "name": "Automatically Approve Quote", "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "ruleCriteria": \[ // ruleCrieteria will be replaced as a whole. Updating only one condition is not supported { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : // Need More details on it. "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : // Need More details on it. "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are opitional // Fulfillment plan design time entities will be created. "EvaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records { "name": "QuoteApproveSuccessTaskGroup", "taks": \[ // create FulfillmentStepDefinition records { "name": "KYC check flow", // FulfillmentStepDefinition API Names "type": "AutoTask",// FulfillmentStepDefinition type "flowApiName": "KYC check flow", // Flow API Names } \] }, "EvaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup { "name": "QuoteApproveFailureTaskGroup", "taks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] } } ### Properties
Name Type Description Required or Optional Available Version
description String Description of the underwriting rule. Optional 63.0
effectiveFromDate String Date from which the underwriting rule is effective. Optional 63.0
effectiveToDate String Date until which the underwriting rule is effective. Optional 63.0
evaluationFailureTaskGroup Evaluation Task Group Input[] Input details for failed evaluation tasks. Optional 63.0
evaluationSuccessTaskGroup Evaluation Task Group Input[] Input details for successful evaluation tasks. Optional 63.0
name String Name of the underwriting rule. Optional 63.0
productPath String Name of the product path. Optional 63.0
ruleCriteria Insurance Rule Criteria Input[] Rule criteria for the underwriting rule. Required 63.0
status String Status of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
 Optional 63.0
## Response Body for PATCH [Insurance Update Underwriting Rules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_underwriting_rules_output.htm "Output representation details of the insurance update underwriting rules request.") # Insurance Underwriting Rules (POST) Create an underwriting rule for a root product based on the selected state definition, transition, and object name. ## Resource /connect/insurance/underwriting-rules ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/underwriting-rules ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "name": "Automatically Approve Quote", "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "status": "Draft", "description": "Rule description”, "underwritingRuleGroup": { "underwritingRuleGroupId": "1KQ000000MKJIK", // Optional, // if underwritingRuleGroupId exist, then use it as parent instead of create a new record. "stageTransitionId": "0jjDR00000000VGAAA", // State Transition id. "stageTransitionName": "Draft to Approved", "objectType": "Quote", "recordType": "--Master--", "fromStage": "Draft", "toStage": "Approved", "rootProductId": "01tDR000000EMslYAG" // Auto Gold. "ruleKey": "UW\_\_autoSilver\_\_DraftToApproved\_\_VehicleValueLessThan200K" "criteriaExpression": "1" // Exmple "(1 AND 2) OR 3" if more than 1 rules. } "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "sequence": 1, "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : // Need More details on it. "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : // Need More details on it. "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are optional // Fulfillment plan design time entities will be created. "evaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records { "name": "QuoteApproveSuccessTaskGroup", "tasks": \[ // create FulfillmentStepDefinition records { "name": "KYC check flow", // FulfillmentStepDefinition API Names "type": "AutoTask",// FulfillmentStepDefinition type "flowApiName": "KYC check flow", // Flow API Names } \] }, "evaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup { "name": "QuoteApproveFailureTaskGroup", "tasks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] } } ### Properties
Name Type Description Required or Optional Available Version
apiName String Unique API name of the underwriting rule. Required 63.0
description String Description of the underwriting rule Optional 63.0
effectiveFromDate String Date from which the underwriting rule is effective. Required 63.0
effectiveToDate String Date until which the underwriting rule is effective. Optional 63.0
evaluationFailureTaskGroup Evaluation Task Group Input [] Input details for failed evaluation tasks. Optional 63.0
evaluationSuccessTaskGroup Evaluation Task Group Input [] Input details for successful evaluation tasks. Optional 63.0
name String Name of the underwriting rule Required 63.0
productPath String Name of the product path. Required 63.0
ruleCriteria Insurance Rule Criteria Input [] Rule criteria for the underwriting rule. Required 63.0
ruleKey String Unique key for the variable defined in CML (Constraint Modeling Language) that represents the constraint for the insurance product clause. The format must be `UW__<productCode>__<stageTransitionName>__<ruleApiName>`.

If not specified, the API generates the rule key based on the defined product clause.

 Optional 67.0
status String Status of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
 Optional 63.0
underwritingRuleGroup Insurance Underwriting Rule Group Input [] The UnderwritingRuleGroup input data. Required 63.0
## Response Body for POST [Insurance Create Underwriting Rules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_underwriting_rules_output.htm "Output representation details of insurance create underwriting rules request.") # Insurance Underwriting Rules Error Details of the error response. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Error code. | Big, 63.0 | 63.0 | | message | String | Message stating the reason for error, if any. | Big, 63.0 | 63.0 | # Insurance Update Member Plans Output representation for the update member plans operation. ## JSON Example { "errors": \[\], "failedPlans": \[\], "isSuccess": true, "memberId": "0r6xx000000001aEAA", "updatedMemberPlans": \[ "0r8xx000000003jEAA" \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error\[\]](connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.") | List of errors that occurred for the API request. | Small, 65.0 | 65.0 | | failedPlans | String\[\] | List of plan IDs that failed to be updated. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the overall operation is successful (true) or not (false). | Small, 65.0 | 65.0 | | memberId | String | ID of the group census member. | Small, 65.0 | 65.0 | | updated​MemberPlans | String\[\] | List of IDs for the member plan records that are successfully updated. | Small, 65.0 | 65.0 | # Insurance Update Member Plans Input Input representation for updating the plans that are associated with a census member. ## JSON Example { "addedPlans": { "values": \[ { "contractGroupPlanId": "0rgSG0000000e8jYAA" }, { "contractGroupPlanId": "0rgSG0000000eALYAY" } \] }, "upsertedPlans": { "contractGroupPlanId": "0rgxx00000000OEAAY", "attributes": { "values": \[ { "attributeCode": "Deductible", "attributeValue": "0" } \] } }, "deletedPlans": { "values": \[ "0rgSG0000000eALYAY", "0rgSG0000000e8jYAA" \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of plans to add to the member. | Optional | 65.0 | | deletedPlans | String\[\] | List of group census member plan IDs to delete. | Optional | 65.0 | | upsertedPlans | [Group Census Member Plan Input\[\]](connect_requests_group_census_member_plan_input.htm "Input representation for a single plan or coverage for a group census member.") | List of existing member plans to update or add if they don't exist, including attribute-level changes to plans the member already has. | Optional | 65.0 | # Insurance Update Underwriting Rules Output representation details of the insurance update underwriting rules request. ## JSON Example This example shows a sample success response. { "underwritingRuleId": "11pxx0000005RE4AAM", "isActive": false, "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Underwriting Rules Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rules_error.htm "Details of the error response.")\[\] | List of errors encountered during the processing of the API request. | Big, 63.0 | 63.0 | | isActive | Boolean | Indicates whether the rule is active (true) or not (false). | Big, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the request is successful (true) or not (false). | Big, 63.0 | 63.0 | | underwritingRuleId | String | ID of the underwriting rule. | Big, 63.0 | 63.0 | # Insurance Update Underwriting Rules Input Update Underwriting Rule Input Representation ## JSON Example { "name": "Automatically Approve Quote", "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "ruleCriteria": \[ // ruleCrieteria will be replaced as a whole. Updating only one condition is not supported { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : // Need More details on it. "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : // Need More details on it. "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are opitional // Fulfillment plan design time entities will be created. "EvaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records { "name": "QuoteApproveSuccessTaskGroup", "taks": \[ // create FulfillmentStepDefinition records { "name": "KYC check flow", // FulfillmentStepDefinition API Names "type": "AutoTask",// FulfillmentStepDefinition type "flowApiName": "KYC check flow", // Flow API Names } \] }, "EvaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup { "name": "QuoteApproveFailureTaskGroup", "taks": \[ { "name": "Vehicle ineligible", "type": "AutoTask", "flowApiName": "Mail Notification - Vehicle ineligible", } \] } } ## Properties
Name Type Description Required or Optional Available Version
description String Description of the underwriting rule. Optional 63.0
effectiveFromDate String Date from which the underwriting rule is effective. Optional 63.0
effectiveToDate String Date until which the underwriting rule is effective. Optional 63.0
evaluationFailureTaskGroup Evaluation Task Group Input[] Input details for failed evaluation tasks. Optional 63.0
evaluationSuccessTaskGroup Evaluation Task Group Input[] Input details for successful evaluation tasks. Optional 63.0
name String Name of the underwriting rule. Optional 63.0
productPath String Name of the product path. Optional 63.0
ruleCriteria Insurance Rule Criteria Input[] Rule criteria for the underwriting rule. Required 63.0
status String Status of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
 Optional 63.0
# Insurance Upsert Member Input Input representation of a group census member and the additional field values to apply during an upsert operation. ## JSON Example { "memberId": "0YLxx0000004C92EAG", "fields": \[ { "key": "Status\_\_c", "value": "Active" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | Key-value pairs that specify the additional field values to apply to the specified member. | Optional | 68.0 | | memberId | String | Unique identifier of the member. This value associates the additional field values with the corresponding member. | Optional | 68.0 | # Insurance Validate User Permissions Input Input representation that specifies the insurance operation and optional user ID for a permissions check. ## JSON Example { "targetOperation": "createPolicy", "userId": "005xx000001X7roAAC" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | targetOperation | String | Insurance operation to validate against the user’s permission. Valid values are: executeQuote, browseCatalog, createQuote, rateProduct, createPolicy, endorsePolicy, cancelPolicy, reinstatePolicy, createSurcharge, createUnderwritingRules, and createClause. Unknown or blank values return an invalid result with the list of supported identifiers. | Required | 68.0 | | userId | String | ID of the user to check the permission for. If not specified, the API validates permission for the current user. | Optional | 68.0 | # Insurance Validate User Permissions Response Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t. ## JSON Example { "isValid": false, "instructions": "User requires the 'DigitalInsurancePolicyAdminUser' permission to create policies. Please assign the appropriate permission set to this user." } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | instructions | String | Human-readable troubleshooting guidance when isValid is false. This property shows how to resolve the user’s missing access privileges, such as which permission set to assign. Omitted or null when the user is permitted. | Big, 68.0 | 68.0 | | isValid | Boolean | Indicates whether the user has the required permissions. Returns true when the user meets all necessary org-level and user-level checks to perform the action; otherwise returns false. | Big, 68.0 | 68.0 | # InsuranceBrokerageFamily Class Manage policy lifecycle, brokerage commissions, and plan benefits. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_connect_api.htm "HTML (New Window)") - **[InsuranceBrokerageFamily Methods](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_methods.htm)** These methods are for InsuranceBrokerageFamily. All methods are static. # InsuranceBrokerageFamily Methods These methods are for InsuranceBrokerageFamily. All methods are static. - **[bulkCancelInsurancePolicy(insurancePolicyBulkInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkCancelInsurancePolicy_1.htm)** Cancel policies in bulk for the specified Insurance Policy IDs. - **[bulkEndorseDraftInsurancePolicy(insurancePolicyBulkFieldMapInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkEndorseDraftInsurancePolicy_1.htm)** Endorse draft policies in bulk for the specified insurance policy IDs. - **[bulkEndorseInsurancePolicy(insurancePolicyBulkInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkEndorseInsurancePolicy_1.htm)** Endorse policies in bulk for the specified insurance policy IDs. - **[bulkIssueInsurancePolicy(insurancePolicyBulkInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkIssueInsurancePolicy_1.htm)** Issue policies in bulk for the specified insurance policy IDs. - **[bulkReinstateInsurancePolicy(insurancePolicyBulkFieldMapInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkReinstateInsurancePolicy_1.htm)** Reinstate policies in bulk for the specified insurance policy IDs. - **[bulkRenewInsurancePolicy(insurancePolicyBulkInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_bulkRenewInsurancePolicy_1.htm)** Renew policies in bulk for the specified Insurance Policy IDs. - **[cancelInsurancePolicy(insurancePolicyCancelInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_cancelInsurancePolicy_1.htm)** Cancel a specific insurance policy by providing the cancellation details and the policy ID. - **[createBillingSchedulesFromTransaction(InsuranceTransactionBillingInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBillingFamily_createBillingSchedulesFromTransaction.htm)** Create billing schedules from an insurance transaction. - **[endorseDraftInsurancePolicy(insurancePolicyDraftProcessInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_endorseDraftInsurancePolicy_1.htm)** Create an endorsement draft for a specific insurance policy by providing the draft input details and the policy ID. - **[endorseInsurancePolicy(policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_endorseInsurancePolicy_1.htm)** Endorse a specific insurance policy by providing the policy ID. - **[getCommissionProcessing(commissionProcessingInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_getCommissionProcessing_1.htm)** Process commission statements in an asynchronous manner by using the preconfigured batch job. - **[issueInsurancePolicy(policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_issueInsurancePolicy_1.htm)** Issue a specific insurance policy by providing the policy ID. - **[previewPolicyPremium(premiumPreviewInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_previewPolicyPremium_1.htm)** Preview prorated and rolled-up premium amounts across a draft insurance policy hierarchy without creating or updating changes. - **[reinstateInsurancePolicy(insurancePolicyReinstatementInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_reinstateInsurancePolicy_1.htm)** Reinstate a previously canceled insurance policy by providing the reinstatement details and the policy ID. - **[renewInsurancePolicy(insurancePolicyProcessInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceBrokerageFamily_renewInsurancePolicy_1.htm)** Renew policy for the specified insurance policy ID. # InsuranceClaimFamily Class Manage insurance claims. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_connect_api.htm "HTML (New Window)") - **[InsuranceClaimFamily Methods](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_methods.htm)** These methods are for InsuranceClaimFamily. All methods are static. # InsuranceClaimFamily Methods These methods are for InsuranceClaimFamily. All methods are static. - **[CalculateAdjustments(CalculateAdjustmentsInput, claimId, coverageId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_CalculateAdjustments.htm)** Calculate adjustments for a loss item and determine the final payable amount for a specific claim loss item. - **[CancelClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_CancelClaimCoveragePaymentDetail.htm)** Cancel payment for a claim coverage payment detail record. - **[CheckFinancialAuthority(paymentDetailId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_CheckFinancialAuthority.htm)** Check whether the current user has the financial authority to pay a specified claim coverage payment detail record. - **[CreateClaim(CreateClaimInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_ClaimFamily_CreateClaim.htm)** Create a claim record. - **[CreateClaimCoverage(claimId, CreateClaimCoverageInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_ClaimFamily_CreateClaimCoverage.htm)** Create a claim coverage record. - **[CreateClaimCoveragePaymentDetail(CreateClaimCoveragePaymentDetailInput, claimId, coverageId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_CreateClaimCoveragePaymentDetail.htm)** Create a claim coverage payment detail record. - **[CreatePolicyLimits(policyId, CreatePolicyLimitsInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_CreatePolicyLimits.htm)** insurance policy limit records for the specified policy based on the defined attributes and coverages of the insurance policy. - **[DeleteClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_DeleteClaimCoveragePaymentDetail.htm)** Delete a claim coverage payment detail record. - **[EditClaimCoveragePaymentDetail(EditClaimCoveragePaymentDetailInput, claimId, coverageId, paymentDetailId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_EditClaimCoveragePaymentDetail_1.htm)** Modify a claim coverage payment detail record. - **[GetClaim(claimId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_ClaimFamily_GetClaim.htm)** Get the details of a specific claim. - **[PayClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId, PayClaimCoveragePaymentDetailInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_PayClaimCoveragePaymentDetail.htm)** Process payment for a specific claim coverage payment detail record. - **[PolicyLimitStandingCalculation(InsurancePolicyLimitStandingCalculationInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_PolicyLimitStandingCalculation.htm)** Calculate the current standing for policy limits. - **[postVerifyPolicyCoverage(policyId, coverageId, verifyPolicyCoverageInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_postVerifyPolicyCoverage.htm)** Verify the applicability of a policy coverage for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. - **[PayExGratiaClaimCvrPaymentDetail(claimId, coverageId, paymentDetailId, PayExGratiaClaimCvrPaymentDetailInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_PayExGratiaClaimCvrPaymentDetail.htm)** Process an ex gratia payment for a claim coverage payment detail record. - **[ProcessPolicyLimits(ProcessPolicyLimitsInput, claimId, coverageId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_ProcessPolicyLimits.htm)** Process the policy limits for a loss item in a claim by using the current standings of the insurance policy limits. - **[RecalculateAdjustments(claimId, coverageId, RecalculateAdjustmentsInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceClaimFamily_RecalculateAdjustments.htm)** Recalculate adjustments for existing payment details. - **[UpdateClaim(claimId, UpdateClaimInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_ClaimFamily_UpdateClaim.htm)** Update the details of a specific claim. - **[UpdateClaimCoverage(claimId, coverageId, UpdateClaimCoverageInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_ClaimFamily_UpdateClaimCoverage.htm)** Update the details of a specific coverage in a claim. # InsuranceClause Defines the terms and conditions associated with a product. For example, an Avocation Clause excludes coverage if the insured engages in a risky hobby. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique name of the insurance clause. ### Code - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique code that represents the insurance clause. ### ContentText - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The template, containing variables, used to generate the clause statement. ### CreationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies how the insurance clause is added. - **Possible values**: - AutoAdded - Manual ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the insurance clause becomes active. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when insurance clause becomes inactive. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the insurance clause. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of insurance clause. - **Possible values**: - Clause - Exclusion ### Variables - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The variables (tokens) in the ContentTextthat are replaced with values when generating the clause statement. # InsuranceDesignAdvisorFamily Class Use the Insurance Design Advisor Apex methods at design time to validate product model setup, attributes, pricing configuration, API request payloads, user permissions, and related insurance configuration before runtime. To use these methods, the org must have Insurance Design Advisor enabled. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_connect_api.htm "HTML (New Window)") - **[InsuranceDesignAdvisorFamily Methods](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_methods.htm)** These methods are for InsuranceDesignAdvisorFamily. All methods are static. # InsuranceDesignAdvisorFamily Methods These methods are for InsuranceDesignAdvisorFamily. All methods are static. - **[getRatingInput(insGetRatingInputInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_getRatingInput_1.htm)** Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API after replacing sample values with real data. - **[lookupErrorCode(insLookupErrorCodeInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_lookupErrorCode_1.htm)** Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions when a product model validation error is encountered during setup. - **[validateApiRequest(insRequestValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateApiRequest_1.htm)** Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model. - **[validateAttributes(insAttributeValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateAttributes_1.htm)** Validate that the specified attribute definitions exist in the org and are active. This method returns a per-attribute validation status with resolution guidance for any attribute that can't be validated. - **[validateCMLModel(insCMLModelValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateCMLModel_1.htm)** Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent. - **[validatePricingSetup(insPricingSetupValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validatePricingSetup_1.htm)** Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. - **[validateProductDiscovery(insProductDiscoveryValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateProductDiscovery_1.htm)** Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. - **[validateProductModel(insProductModelValidationInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateProductModel_1.htm)** Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. - **[validateUserPermissions(insValidateUserPermissionsInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceDesignAdvisorFamily_validateUserPermissions_1.htm)** Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy, and return troubleshooting guidance when the user isn’t authorized. # InsuranceGroupBenefitsFamily Class Effectively manage the insurance plans that are offered to groups, such as employees and their dependents, by using the Group Benefits feature on the Digital Insurance platform. Simplify the Group Benefits workflow through a unified platform for all processes, including census management, quote configuration and pricing, contract creation, and enrollment. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_connect_api.htm "HTML (New Window)") - **[InsuranceGroupBenefitsFamily Methods](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_methods.htm)** These methods are for InsuranceGroupBenefitsFamily. All methods are static. # InsuranceGroupBenefitsFamily Methods These methods are for InsuranceGroupBenefitsFamily. All methods are static. - **[addMembersWithPlans(membersWithPlansInputRepresentation, censusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_addMembersWithPlans.htm)** Add a family of group census members and their insurance plans to a group census in a single request. - **[updateMembersWithPlans(membersWithPlansInputRepresentation, censusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_updateMembersWithPlans.htm)** Update a family of group census members and their insurance plans in a group census in a single request. - **[deepCloneGroupCensus(groupCensusDeepCloneInputRepresentation, censusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_deepCloneGroupCensus.htm)** Clone a group census and its hierarchy, including members, member plans, and plan attributes. Use this method to copy quoting-phase census data into an enrollment-type census, apply field-level overrides, and optionally filter or remap member plan references. - **[mapCensusFields(censusId, groupCensusFieldMappingInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_mapCensusFields.htm)** Map fields on an existing group census to the corresponding quote or contract records without creating new records. Use this method to remap references from quote records to contract records, or from contract records back to quote records, for example after a quote is converted to a contract. - **[postInsuranceGroupEndorsement(censusId, insuranceGroupEndorsementInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceGroupEndorsement.htm)** Apply mid-term contract adjustments to the eligible member policies in a group census. Use this method after an endorsed contract version is created so that member policies reflect the contract changes. - **[postInsuranceGroupRenewal(censusId, insuranceGroupRenewalInputRepresentation)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceGroupRenewal.htm)** Renew insurance policies of group census members for a contract renewal. Use this method to create insurance policies under the renewed contract for each primary census member, link the new policies to their previous policies, and record renewal transactions. - **[postInsuranceAddMembers(censusMgmtInputParam, groupCensusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceAddMembers.htm)** Add new group census members. - **[postInsuranceAddMemberPlans(insuranceAddMemberPlansInputRepresentation, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceAddMemberPlans.htm)** Add plans for a group census member. - **[postInsuranceBulkAddMembers(bulkCensusMgmtInputParam, groupCensusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceBulkAddMembers.htm)** Add or update group census member data in bulk. - **[postInsuranceCheckPlansEligibility(plansEligibilityInputParam, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsGroupBenefits_postCheckPlansEligibility.htm)** Check the eligibility of a group census member for a given set of plans and create a new eligibility context. - **[patchInsuranceCheckPlansEligibility(plansEligibilityInputParamWithContextId, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsGroupBenefits_patchCheckPlansEligibility.htm)** Check the eligibility of a group census member for a set of added and deleted plans within an existing context. - **[postInsuranceCreateAccounts(createAccountsInputParam, createPortalUsers)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceCreateAccounts.htm)** Create person accounts and portal users for group census members. - **[postInsuranceCreateContacts(createContactsInputParam, createPortalUsers)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceCreateContacts.htm)** Create contacts and portal users for group census members. - **[postInsuranceCreateQuoteFromContract(createQuoteFromContractInputParam, contractId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceCreateQuoteFromContract.htm)** Create a quote from an existing insurance contract, including the quote structure and line items. - **[postInsuranceCreateCensus(createCensusInputParam, contractId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceCreateCensus.htm)** Generate a group census from the policies on an existing group benefits contract. - **[patchInsuranceUpdateCensus(updateCensusInputParam, contractId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_patchInsuranceUpdateCensus.htm)** Update a group census from policy enrollments and endorsements on an existing group benefits contract. - **[postInsuranceGenerateRefreshCensusMembers(generateRefreshCensusMembersInputParam, contractId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceGenerateRefreshCensusMembers.htm)** Generate or update group census members from policy information on an existing group benefits contract. - **[postInsuranceIssueContract(issueContractInputParam)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceIssueContract.htm)** Issue a group benefits contract from a quote synchronously to activate coverage. - **[postInsuranceContractEndorse(contractEndorseInputParam)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceContractEndorse.htm)** Create an endorsed contract version from a quote for a mid-term adjustment. - **[postInsuranceContractRenewal(contractRenewalInputParam)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceContractRenewal.htm)** Create a renewed-term group benefits contract from a quote. - **[deleteInsuranceDeleteAllMembers(groupCensusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_deleteInsuranceDeleteAllMembers.htm)** Delete all census members for the specified group census ID. - **[postInsuranceDeleteMemberPlans(insuranceDeleteMemberPlansInputRepresentation, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceDeleteMemberPlans.htm)** Delete the specified plans for a group census member. - **[postInsuranceGroupRating(gbGroupRatingInputParam, quoteId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceGroupRating.htm)** Rate a group benefits quote to calculate premiums for all quote line items. - **[postInsuranceIndividualEnrollment(insuranceIndividualEnrollmentInputParam, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsGroupBenefits_postIndividualEnrollment.htm)** Enroll a group census member in one or more insurance plans, creating the necessary policy records. - **[putInsuranceIndividualMta(insuranceIndividualMtaInputParam, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_putInsuranceIndividualMta.htm)** Apply a mid-term adjustment to the insurance policies of a group census member. - **[getInsuranceMemberEligiblePlans(memberId, shouldIncludeDependents)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_getInsuranceMemberEligiblePlans.htm)** Get the enrollment plans for which a group census member and their dependents are eligible. - **[postInsuranceMembersRating(insuranceMemberRatingInputParam, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceMembersRating.htm)** Calculate pricing for individual members of a group census, with the support for plan and individual coverages within the plan. - **[postInsuranceSyncCensusSummary(groupCensusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_postInsuranceSyncCensusSummary.htm)** Synchronize and recalculate the summary data for a group census. - **[patchInsuranceUpdateMembers(censusMgmtInputParam, groupCensusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_patchInsuranceUpdateMembers.htm)** Update group census members. - **[patchInsuranceUpdateMemberPlans(insuranceUpdateMemberPlansInput, memberId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_patchInsuranceUpdateMemberPlans.htm)** Update the plans that are associated with a group census member. # InsurancePolicyAdminFamily Class Manage insurance policies comprehensively, for different transaction types, such as issuance, endorsement, renewal, and cancellation. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_classes_connect_api.htm "HTML (New Window)") - **[InsurancePolicyAdminFamily Methods](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_methods.htm)** These methods are for InsurancePolicyAdminFamily. All methods are static. # InsurancePolicyAdminFamily Methods These methods are for InsurancePolicyAdminFamily. All methods are static. - **[CancelPolicy(CancelPolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_CancelPolicy_1.htm)** Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation. - **[EndorsePolicy(EndorsePolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_EndorsePolicy_1.htm)** Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the input JSON. - **[GetPolicy(policyId, connectDynamicParameters)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_GetPolicy_1.htm)** Get details of an insurance policy. Pass additional context or metadata to customize the information that's fetched. - **[IssuePolicy(IssuePolicyInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_IssuePolicy_1.htm)** Use the context ID provided in the input JSON to generate a new insurance policy. - **[MultiRootEndorsePolicy(EndorsePolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/pex_ConnectAPI_InsurancePolicyAdminFamily_MultiRootEndorsePolicy.htm)** Resource for the Insurance Multi Root Endorsement Policy Connect API POST Method. - **[MultiRootIssuePolicy(IssuePolicyInput)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_MultiRootIssuePolicy.htm)** Asynchronously create a multi-root insurance policy along with its child policies. - **[MultiRootRenewPolicy(RenewPolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_MultiRootRenewPolicy_1.htm)** Asynchronouly renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. Use the priced context ID for the renewal process. - **[OutOfSequenceEndorsePolicy(OutOfSequenceEndorsePolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_OutOfSequenceEndorsePolicy.htm)** Create an out-of-sequence endorsement for an insurance policy. - **[ReinstatePolicy(ReinstatePolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_ReinstatePolicy_1.htm)** Reinstate a previously canceled insurance policy. - **[RenewPolicy(RenewPolicyInput, policyId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsurancePolicyAdminFamily_RenewPolicy_1.htm)** Use the context ID of an existing policy to renew a policy. Modify the renewal date, and add optional fields and additional information in the input JSON. # InsurancePolicyProductClause Represents all clauses associated with the products that are applicable to a specific insurance policy. The object contains one record for each clause associated with a product that is applicable to a policy. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApplicableObjectType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the type of object the insurance policy product clause applies to. - **Possible values**: - InsurancePolicyAsset—Insurance Policy Asset - InsurancePolicyCoverage—Insurance Policy Coverage - InsurancePolicyParticipant—Insurance Policy Participant ### ClauseText - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The generated clause text based on rule evaluation. ### ConstraintModelDeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The developer name of the constraint model. ### CreationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates how the insurance policy product clause is added. - **Possible values**: - AutoAdded - Manual ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The description of the insurance policy product clause. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the insurance policy product clause becomes active. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the insurance policy product clause becomes inactive. ### InsurancePolicyAssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the policy asset associated with the insurance policy product clause. This field is a relationship field. - **Relationship Name**: InsurancePolicyAsset - **Refers To**: InsurancePolicyAsset ### InsurancePolicyCoverageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the policy coverage associated with the insurance policy product clause. This field is a relationship field. - **Relationship Name**: InsurancePolicyCoverage - **Refers To**: InsurancePolicyCoverage ### InsurancePolicyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the policy associated with the insurance policy product clause. This field is a relationship field. - **Relationship Name**: InsurancePolicy - **Relationship Type**: Master-detail - **Refers To**: InsurancePolicy (the master object) ### InsurancePolicyParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the participant associated with the insurance policy product clause. This field is a relationship field. - **Relationship Name**: InsurancePolicyParticipant - **Refers To**: InsurancePolicyParticipant ### InsuranceProductClauseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the insurance product clause associated with the insurance policy product clause. This field is a relationship field. - **Relationship Name**: InsuranceProductClause - **Refers To**: InsuranceProductClause ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort - **Description**: The name of the insurance policy product clause. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The name of the system from where the insurance policy product clause originated. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The unique identifier of the insurance policy product clause record in the source system. # InsuranceProductClause Represents a junction between a product and an insurance clause. This association defines the clauses applicable for the specific products. For example, an Excluded Driver clause applies to auto and motorcycle insurance products, but not to home insurance products. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The API name of the insurance product clause. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The insurance clause associated with the insurance product clause. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the insurance clause becomes active. ### InsuranceClauseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: This field is a relationship field. - **Relationship Name**: InsuranceClause - **Relationship Type**: Master-detail - **Refers To**: InsuranceClause (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort - **Description**: The name of the insurance product clause. ### ProductPath - **Type**: string - **Properties**: Create, Filter, Group, Sort - **Description**: The path that contains the product IDs that roll up to the parent product. ### ProductRelatedComponentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The product-related component associated with the insurance product clause. This field is a relationship field. - **Relationship Name**: ProductRelatedComponent - **Refers To**: ProductRelatedComponent ### RootProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the parent (root) product that this product rolls up to. This field is a relationship field. - **Relationship Name**: RootProduct - **Refers To**: Product2 ### RuleKey - **Type**: string - **Properties**: Create, Filter, Nillable, Sort - **Description**: The key of the variable defined in CML (Constraint Modeling Language) that represents the constraint for the insurance product clause. # Invoke Underwriting Rules Action Invoke the underwriting rules for different insurance records during the run time. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/invokeUnderwritingRules Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | invokeUnderwritingRuleInputRep | Apex-defined | Required. An Apex ConnectApi.InvokeUnderwritingRuleInputRep record that contains the details of the object records to which the underwriting rules must be applied. | ## Outputs | Output | Type | Description | | --- | --- | --- | | invokeUnderwritingRuleOputRep | Apex-defined | An Apex ConnectApi.InvokeUnderwritingRuleOputRep record that contains the details of the object records to which the underwriting rules are applied. | ## Example Sample Request { "inputs": \[ { "invokeUnderwritingRuleInputRep": { "objectId": "0Zkxx000000001qCAA", "toStage": "Open" } } \] } This is a sample request to call this invocable action from Apex code. public class InsuranceUnderwritingRuleApexService implements Callable { private static final String METHOD\_INVOKE\_UW\_RULE = 'invokeUnderwritingRule'; private static final String OUTPUT\_NAME = 'invokeUnderwritingRuleOputRep'; /\*\* \* @description Implementation of Callable interface for OmniStudio \* @param action Method name to invoke \* @param args Map containing input, output, and options \* @return Object result of the method invocation \*/ public Object call(String action, Map args) { System.debug('InsuranceQuoteApexService: call ' + action); Boolean response = false; Map input = (Map) args.get('input'); Map output = (Map) args.get('output'); Map options = (Map) args.get('options'); if (METHOD\_INVOKE\_UW\_RULE.equals(action)) { if (!input.containsKey('objectId') || input.get('objectId') == null) { throw new IllegalArgumentException('objectId is missing or null'); } if (!input.containsKey('toStage') || input.get('toStage') == null) { throw new IllegalArgumentException('toStage is missing or null'); } String objectId = (String)input.get('objectId'); String toStage = (String)input.get('toStage'); Object ruleResult = invokeUWRules(objectId, toStage); output.put('ruleResult', ruleResult); response = true; } return response; } public static Object invokeUWRules(String objectId, String toStage) { System.debug('InsuranceUnderwritingRuleApexService: objectId:' + objectId + ', toStage : ' + toStage); Object outputRep; try { System.debug('Calling Invocable Action: invokeUnderwritingRules'); // Create and configure the invocable action Invocable.Action action = Invocable.Action.createStandardAction('invokeUnderwritingRules'); // Set required invocation parameters ConnectApi.invokeUnderwritingRuleInputRep inputRep = new ConnectApi.invokeUnderwritingRuleInputRep(); inputRep.objectId = objectId; inputRep.toStage = toStage; action.setInvocationParameter('invokeUnderwritingRuleInputRep', inputRep); // Execute the action List results = action.invoke(); if (results != null && !results.isEmpty()) { Invocable.Action.Result result = results\[0\]; if (result.isSuccess()) { System.debug('Invoke UW Rule successfully from Invocable Action'); // Extract key information from the result Map outputParams = result.getOutputParameters(); if (outputParams != null) { outputRep = outputParams.get(OUTPUT\_NAME); System.debug('output: ' + JSON.serialize(outputRep)); return outputRep; } } else { System.debug('invoke UW Rule fail: ' + result); return result.getErrors(); } } } catch (Exception e) { throw e; } return outputRep; } } Sample Response \[ { "actionName": "invokeUnderwritingRules", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "invokeUnderwritingRuleOputRep": { "objectId": "0Zkxx000000001qCAA", "objectName": "Claim", "fromStage": "Draft", "toStage": "Open", "stageTransitionName": "Draft to Open", "stageTransitionUnderwritingEvaluationId": "1Mjxx00000004C0CA2", "isSuccess": true, "rulesetResults": \[ { "productId": "01tSM000005OFyGYAW", "evaluationCriteria": "1 OR 2", "isSuccess": true, "ruleResults": \[ { "ruleApiName": "CollisionRule", "isSuccess": true }, { "ruleApiName": "AutoSilverRule", "isSuccess": true } \] }, { "productId": "01tSM000005OFyJYAW", "evaluationCriteria": "1", "isSuccess": true, "ruleResults": \[ { "ruleApiName": "MedicalRule1", "isSuccess": true } \] } \] } }, "sortOrder": -1, "version": 1 } \] # Issue Contract From Quote (POST) Create a contract from a quote synchronously, along with contract group plans and attributes, based on the quote configuration for new business. ## Resource /connect/insurance/contracts/actions/issue ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/actions/issue ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000004C9OCAU", "contractStartDate": "2026-01-11", "contractEndDate": "2028-01-20", "transactionDetailLevel": "COVERAGE\_LEVEL", "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to add to contract items. | Optional | 68.0 | | contractEndDate | String | End date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract end date that’s derived from the quote. | Required | 68.0 | | contractStartDate | String | Start date of the contract in ISO 8601 YYYY-MM-DD format. If specified, this value overrides the contract start date that’s derived from the quote. | Required | 68.0 | | contractTerm | Integer | Duration of the contract in months. If specified, this value overrides the contract term derived from the quote. | Optional | 68.0 | | quoteId | String | ID of the quote from which you want to issue the contract. | Required | 68.0 | | transactionDetailLevel | String | Level of transaction detail to include when issuing the contract. Valid values are: PLAN\_LEVEL, COVERAGE\_LEVEL, CHARGE\_LEVEL. The default value is PLAN\_LEVEL. | Optional | 68.0 | ## Response Body for POST [Issue Contract Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_issue_contract.htm "Output representation of the details when a group benefits contract is issued synchronously from a quote.") # Issue Contract From Quote Asynchronous (POST) Create a group benefits contract from a quote. This API supports asynchronous operation for long-running conversions. ## Resource /connect/insurance/contracts ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0SG000000DQA00AO", "contractStartDate": "2025-03-11", "contractEndDate": "2026-03-11", "enrollmentStartDate": "2025-01-01", "enrollmentEndDate": "2025-02-01", "contractTerm": 1, "additionalFields": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "CustomerSignedTitle", "value": "Mr" } \] } }, { "entity": "ContractGroupPlan", "instanceKey": "d5861be1-9920-42d9-8f43-093b0a709d35", "fields": { "data": \[ { "key": "EligibilityCriteria", "value": "testcriteria" } \] } } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Contract Item](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_contract_item.htm "Input representation for additional fields to be added to contract items.")\[\] | List of additional fields to add to contract items. | Optional | 65.0 | | contractEndDate | String | End date of the contract. | Required | 65.0 | | contractStartDate | String | Start date of the contract. | Required | 65.0 | | contractTerm | Integer | Contract terms in months. | Optional | 65.0 | | enrollmentEndDate | String | End date for plan enrollment. | Optional | 65.0 | | enrollmentStartDate | String | Start date for plan enrollment. | Optional | 65.0 | | quoteId | String | ID of the quote to create the contract from. | Required | 65.0 | ## Response Body for POST [Contract Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_creation_output.htm "Output representation of the group benefits Quote-to-Contract process.") # Issue Contract Response Output representation of the details when a group benefits contract is issued synchronously from a quote. ## JSON Example { "contractId": "800xx000000br2bAAA", "errors": \[\], "isSuccess": true, "message": "Contract issued successfully from quote." } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the contract that's issued. | Small, 68.0 | 68.0 | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while issuing the contract. Empty when the request succeeds. | Small, 68.0 | 68.0 | | insuranceContractId | String | ID of the insurance contract record associated with the issued contract. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the contract is issued successfully (true) or not (false). | Small, 68.0 | 68.0 | # Issue Insurance Brokerage Policy Action Issue an insurance brokerage policy by specifying the policy ID. This action is available in API version 67.0 and later. ## Special Access Rules The Issue Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/issueInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_IssueBrokeragePolicyIAInputRep record that contains the ID of the insurance brokerage policy to issue. | ## Outputs | Output | Type | Description | | --- | --- | --- | | transactionId | string | Transaction ID that's generated during the policy issuance operation. | ## Example **POST** This sample request is for the Issue Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for issuing a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('issueInsBrokeragePolicy'); // Instantiate the input object ConnectApi.IssueBrokeragePolicyIAInputRep input = new ConnectApi.IssueBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the brokerage policy to be issued input.policyId = '0YjXX0000000001'; // Set the invocation parameter and invoke action.setInvocationParameter('issueBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Issue Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Issue Insurance Brokerage Policy action. \[ { "actionName": "issueInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "transactionId": "txn\_abc123def456" }, "sortOrder": -1, "version": 1 } \] # Issue Insurance Policy (POST) Use the context ID provided in the request body to generate a new insurance policy. If you want to calculate billing during an insurance policy issuance process, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource /connect/insurance/policies ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextId": "3561319f267fd53380bc38c049a01c8089876e833a321860766d35a9c40b67df", "insurancePolicy": { "policyName": "Mr. Bret Lees Policy", "policyNumber": "Policy-Bret-OneYear", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-10-31" }, "transactionRecord": { "name": "New Policy" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } }, { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API or the Multiroot Issue Inurance Policy API is generated by the Create Insurance Quote API. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when issuing the policy. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the policy or quote that’s used to create the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to create the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that’s used to override transaction information. | Optional | 63.0 | ## Response Body for POST [Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_output.htm "Output representation of policy details.") # Issue Insurance Policy Action Issue an insurance policy by using a set of user inputs that represent policy details. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/issueInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Details
issuePolicyIAInputRep Type

Apex-defined

Description

An Apex ConnectApi.IssuePolicyIAInputRep record that contains the details of the policy to be issued. To calculate billing, provide billingRecord details if Career Billing is enabled in your org.
## Outputs
Output Details
issuedPolicyId Type

String

Description

ID of the issued policy.
## Example Sample Request { "inputs": \[ { "IssuePolicyIAInputRep": { "contextId": "c98a08a0a9725b7a7d42c35d02e49d80c77a5aae4ea687b0bf09a7997d2af3d3", "insurancePolicy": { "policyName": "Test Auto Ins policy Via REST", "policyNumber": "PLC5678987", "effectiveFromDate" : "2024-01-01", "effectiveToDate" : "2024-12-31", "standardFee": "1011" }, "transactionRecord": { "name": "Sold Policy Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key":"AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key":"SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList":\[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key":"Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key":"PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } Sample Response \[ { "actionName": "issueInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "issuedPolicyId": "0YTSG000000PgSH4A0" }, "sortOrder": -1, "version": 1 } \] # Issue Multi-Root Insurance Policy Action Create a new multi-root insurance policy along with its associated child policies asynchronously. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/issueMultiRootInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | issueMultiRootPolicyInputRep | Apex-defined | Required. An Apex ConnectApi.IssueMultiRootPolicyInputRep record that contains the details to create a new multi-root insurance policy along with its child policies. To calculate billing, specify billingRecord details if Career Billing is enabled in your org. | ## Outputs | Output | Type | Description | | --- | --- | --- | | jobIdentifier | string | A unique system-generated ID for the asynchronous job that processes the issuance of a new multi-root insurance policy. | ## Example **POST** This sample request is for the Issue Multi-Root Insurance Policy action. { "inputs": \[ { "issueMultiRootPolicyInputRep": { "contextId": "c98a08a0a9725b7a7d42c35d02e49d80c77a5aae4ea687b0bf09a7997d2af3d3", "insurancePolicy": { "policyName": "Test Auto Ins policy Via REST", "policyNumber": "PLC5678987", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-12-31", "referencePolicyNumber": "1011" }, "transactionRecord": { "name": "Sold Policy Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key": "AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key": "SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList": \[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key": "Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key": "PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } This is a sample code to call the Issue Multi-Root Insurance Policy action from Apex. public with sharing class MultiRootPolicyIssuanceInvocable { /\*\* \* Execute Multi-Root Policy Issuance with parameters map \* Usage: MultiRootPolicyIssuanceInvocable.executeMultiRootIssuance(paramsMap); \* \* @param params Map of parameters: \* - contextId (String, REQUIRED) \* - policyName (String, optional) \* - policyNumber (String, optional) \* - referencePolicyNumber (String, optional) \* - effectiveFromDate (String, optional) \* - effectiveToDate (String, optional) \* - transactionName (String, optional) \* - additionalFields (Map>, optional) \*/ public static void executeMultiRootIssuance(Map params) { // Extract and validate contextId (REQUIRED) String contextId = (String) params.get('contextId'); if (String.isBlank(contextId)) { System.debug('ERROR: contextId is required'); return; } // Multi-Root Issue Policy IA - Create the standard Invocable Action Invocable.Action action = Invocable.Action.createStandardAction('issueMultiRootInsurancePolicy'); // Instantiate the IA input object for Multi-Root Policy Issuance // IMPORTANT: Use IssueMultiRootPolicyInputRep, NOT IssuePolicyIAInputRep ConnectApi.IssueMultiRootPolicyInputRep policyInput = new ConnectApi.IssueMultiRootPolicyInputRep(); // Set context ID (REQUIRED) policyInput.contextId = contextId; // Extract optional parameters String policyName = (String) params.get('policyName'); String policyNumber = (String) params.get('policyNumber'); String referencePolicyNumber = (String) params.get('referencePolicyNumber'); String effectiveFromDate = (String) params.get('effectiveFromDate'); String effectiveToDate = (String) params.get('effectiveToDate'); String transactionName = (String) params.get('transactionName'); Map> additionalFields = (Map>) params.get('additionalFields'); // Populate Insurance Policy details (using IA classes) - all optional if (!String.isBlank(policyName) || !String.isBlank(policyNumber) || !String.isBlank(referencePolicyNumber) || !String.isBlank(effectiveFromDate) || !String.isBlank(effectiveToDate)) { ConnectApi.InsPolicyIAInputRep insurancePolicy = new ConnectApi.InsPolicyIAInputRep(); if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(policyNumber)) { insurancePolicy.policyNumber = policyNumber; } if (!String.isBlank(referencePolicyNumber)) { insurancePolicy.referencePolicyNumber = referencePolicyNumber; } if (!String.isBlank(effectiveFromDate)) { insurancePolicy.effectiveFromDate = effectiveFromDate; } if (!String.isBlank(effectiveToDate)) { insurancePolicy.effectiveToDate = effectiveToDate; } policyInput.insurancePolicy = insurancePolicy; } // Populate Transaction record (using IA transaction representation) - optional if (!String.isBlank(transactionName)) { ConnectApi.InsPolicyTrxnIAInputRep transactionRecord = new ConnectApi.InsPolicyTrxnIAInputRep(); transactionRecord.name = transactionName; policyInput.transactionRecord = transactionRecord; } // Populate additional input for multi-root policies - optional if (additionalFields != null && !additionalFields.isEmpty()) { List additionalInputList = new List(); for (String instanceKey : additionalFields.keySet()) { ConnectApi.InsPolicyAddlInputIARep additionalInput = new ConnectApi.InsPolicyAddlInputIARep(); // Set instance key (e.g., "AutoSilver", "FamilyHealth") additionalInput.instanceKey = instanceKey; // Build additional fields list for this instance Map fieldsMap = additionalFields.get(instanceKey); if (fieldsMap != null && !fieldsMap.isEmpty()) { List fieldsList = new List(); for (String fieldKey : fieldsMap.keySet()) { ConnectApi.AdditionalFieldIARep field = new ConnectApi.AdditionalFieldIARep(); field.key = fieldKey; field.value = fieldsMap.get(fieldKey); fieldsList.add(field); } additionalInput.additionalFieldsList = fieldsList; } additionalInputList.add(additionalInput); } policyInput.additionalInput = additionalInputList; } // Set invocation parameters // IMPORTANT: Parameter name is issueMultiRootPolicyInputRep (camelCase) action.setInvocationParameter('issueMultiRootPolicyInputRep', policyInput); System.debug('Starting Multi-Root Policy Issuance Invocable Action (issueMultiRootInsurancePolicy)...'); System.debug('Context ID: ' + contextId); if (!String.isBlank(policyName)) { System.debug('Policy Name: ' + policyName); } try { // Invoke the action List results = action.invoke(); System.debug('Multi-Root Policy Issuance IA result = ' + results); // Process results for (Invocable.Action.Result result : results) { if (result.isSuccess()) { System.debug('SUCCESS: Multi-Root Policy Issuance completed successfully!'); Object outputValue = result.getOutputParameters().get('jobIdentifier'); if (outputValue != null) { System.debug('Job Identifier: ' + outputValue); } else { System.debug('Multi-Root Policy Issuance job started - result: ' + result.getOutputParameters()); } } else { System.debug('ERROR: Multi-Root Policy Issuance failed'); System.debug('Error Details: ' + result.getErrors()); } } } catch (Exception e) { System.debug('EXCEPTION in Multi-Root Policy Issuance Invocable Action: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); } } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ Map params = new Map(); params.put('contextId', ); params.put('policyName', 'James Multi-Root Policy'); params.put('policyNumber', 'James Multi-Root Policy'); params.put('referencePolicyNumber', 'James1234'); params.put('effectiveFromDate', '2026-01-01'); params.put('effectiveToDate', '2026-10-31'); params.put('transactionName', 'Sold Policy Transaction'); // Build additional fields configuration Map> additionalFields = new Map>(); // Configuration for AutoSilver instance Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy'); autoFields.put('Name', 'James Auto Policy'); additionalFields.put(, autoFields); // Configuration for FamilyHealth instance Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy'); healthFields.put('Name', 'James Medical Policy'); additionalFields.put(, healthFields); params.put('additionalFields', additionalFields); MultiRootPolicyIssuanceInvocable.executeMultiRootIssuance(params); This sample response is for the Issue Multi-Root Insurance Policy action. \[ { "actionName": "issueMultiRootInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "jobIdentifier": "55SG000000PgSH4A0" }, "sortOrder": -1, "version": 1 } \] # Issue Multi-Root Policy The policy issuance process begins after the policyholder accepts the quote provided by the insurance company. This process creates a parent–child insurance policy structure in which a parent policy serves as a lifecycle container for one or more insured child policies. Make sure you have these details before issuing a multi-root policy: - The Quote ID of the finalized multi-root quote. - A fully priced context to pass to the Multi-Root Policy Issuance API. - For multi-root quotes configured through the Quote UI, click the Reprice All button on the Transaction Line Item Table (TLT) after all products are configured to ensure pricing and aggregate amounts are correctly reflected at the quote level. 1. Create Quote—Create a quote by using one of the following methods - Make a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) connect API. - Use the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm) invocable action. - Use the [Salesforce Quote User Interface.](https://help.salesforce.com/s/articleView?id=ind.insurance_quoting_611021.htm&type=5&language=en_US) Creates the quote and generates the quote ID. 2. Get Quote Context—Retrieve the quote context by using the quote ID through one of the following methods - Make a GET request to the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm) Connect API - Use the [Get Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.260.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_quote_details.htm) invocable action. Returns the context ID that contains the quote context. 3. Issue Multi-Root Policy—Use the context details, specifically the context ID, to issue multi-root policy by using one of the following methods - Make a POST request to the [Multi-Root Policy Issuance](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_multi_root_issue_policy.htm) connect API. - Use the [Issue Multiroot Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_multi_root_insurance_policy.htm) invocable action. - You can override the context data, such as policy name, policy number, effective-from date, effective-to date, and any other additional fields, to provide values for the custom fields during the API call. You can also specify a name for the transaction record that’s created as part of the policy issuance process. This transaction record is used for audit tracking and financial reference. - Pricing does not occur during this lifecycle event. The context that you pass to this request must already be fully priced. - All policy lifecycle operations occur only on the parent policy and not on child policies. The parent policy isn't associated with any product and doesn't have any line items or attributes, except for its associated child policies. - Returns an Async Request ID as a response to track the job status. - Creates a multi-root policy with the following structure: - A parent policy that represents the policy lifecycle. - One or more insured child policies, created for each root product bundle and linked to the parent policy. - Rolls up premiums and taxes from child policies to the parent policy for a consolidated financial view. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. - Sends a success or failure notification after the process completes. # Issue Multi-Root Policy Creates a new multi-root insurance policy when quoting is managed outside Salesforce by a third-party system. This process uses the Rating API to generate a priced context and create a parent–child policy structure without persisting a quote record. Make sure you have these details before issuing a multi-root policy: - Inputs provided to the Issue Multi-Root Policy API in addition to the context ID. These inputs include policy-level details such as policy name, effective start and end dates. - The context is priced using the Rating API before calling the Issue Multi-Root Policy API. 1. (Optional) Run Qualification Rules—To determine eligibility before pricing, run qualification rules by making a POST request on the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) API with saveQuote=false. Returns an updated context that contains eligibility results without saving a Quote record. 2. Generate Price-adjusted Context—Generate a price-adjusted context by using one of the following methods: - Make a POST request to the [Insurance Product Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API. - Make a POST or PATCH request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) API with saveQuote=false. Returns a price-adjusted context that includes calculated premiums required for policy issuance. 3. Issue Multi-Root Policy—Use the context details, specifically the context ID, along with user inputs to issue a multi-root policy by using one of the following methods: - Making a POST request on the [Multi-Root Policy Issuance](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_multi_root_issue_policy.htm) Connect API. - Use the [Issue Multiroot Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_multi_root_insurance_policy.htm) invocable action. - Returns an Async Request ID as a response to track the job status. - Creates a multi-root policy with the following structure: - A parent policy that represents the policy lifecycle. - One or more insured child policies are created for each root product bundle and linked to the parent policy. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. # Issue Policy The policy issuance process begins after the policyholder accepts the quote provided by the insurance company. This diagram outlines the sequence of issuing a policy based on a quote. ![A flow diagram representing the sequence of issuing a policy based on a quote.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/issue_policy_with_quote.png) 1. **Create Quote**—Create a quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action, or - Using the [Salesforce Quote User Interface](https://help.salesforce.com/s/articleView?id=ind.insurance_quoting_611021.htm&type=5&language=en_US "HTML (New Window)"). This process creates the quote and generates the quote ID. 2. **Get Quote Context**—Use the quote ID to retrieve the quote details either by: - Making a GET request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_quote_details.htm "HTML (New Window)") invocable action. This request returns the context ID in the response that contains the context of the quote. 3. **Issue Policy**—Use the context details, specifically the context ID, to issue policy either by: - Making a POST request on the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_policy.htm "HTML (New Window)") Connect API, or - Using the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_insurance_policy.htm "HTML (New Window)") invocable action. You can override the context data, such as policy name, policy number, effective-from date, effective-to date, and any other additional fields to provide the values for the custom fields during the API call. You can also specify a name for the transaction record that’s created as part of the policy issuance process. This transaction record is used to track an audit or as a financial marker. This request creates a new policy record. **Expected Results:** - A new policy record is created and saved in Salesforce. The policy record includes the details, such as the policy name, number (if provided or created during the API call), policy start date, chosen coverage, and the price. - Any custom field values that are provided during the API call are saved to the new policy record. - A transaction record is created and linked to the policy. # Issue Policy Issue a new insurance policy when quoting is managed outside Salesforce, by a third-party system. This process results in the creation of a policy record in Salesforce, formally establishing coverage for the customer. Use the Rating API to generate a price-adjusted context. This price-adjusted context contains the calculated premium and other relevant details that are required to issue a policy. This process bypasses the need for a formal Salesforce Quote record for pricing. This diagram outlines the sequence of issuing a policy without using Salesforce quote, rather by using the Rating API to generate a price-adjusted context that's used to issue a policy. ![A flow diagram representing the user journey for issuing a policy by using the Rating API.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/issue_policy_without_quote.png) 1. **(Optional)Run Qualification Rules**—If customers want to determine the policyholder’s eligibility for a product, run the qualification rules either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Set the saveQuote parameter to false. It doesn't save the quote and returns an updated context with the eligibility details. 2. **Generate Price-adjusted Context**—Make a POST request on the [Insurance Product Ratings](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API. You must include additionalFields in the request payload with either a QuoteAccount or an Opportunity ID that's linked to an account to generate the context. 3. **Issue Policy**—Use the price-adjusted context record to issue a policy either by: - Making a POST request on the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_policy.htm "HTML (New Window)") Connect API, or - Using the [Issue Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_issue_insurance_policy.htm "HTML (New Window)") invocable action. You can override the context data, such as policy name, policy number, effective-from date, effective-to date, and any other additional fields to provide the values for the custom fields during the API call. You can also specify a name for the transaction record that’s created as part of the policy issuance process. This transaction record is used to track an audit or as a financial marker. This request creates a new policy record. **Expected Results:** - A new policy record is created and saved in Salesforce. The policy record includes the details, such as the policy name, number (if provided or created during the API call), policy start date, the coverage you chose, and the price. - Any custom field values that are provided during the API call are saved to the new policy record. - A transaction record is created and linked to the policy. # Issue Policy (PATCH) Issue a policy using the policy ID. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/issue ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx0000000001GAA/issue ## Available Version 67.0 ## HTTP Methods PATCH ## Request Parameters for POST | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | policyId | Id | ID of the insurance policy to issue. The key prefix is 0YT. | Required | ## Response Body for PATCH [Insurance Policy Issue Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_issue_output.htm "Output representation details of the issue policy and issue endorse policy requests.") # Issue Policy Input Input representation of the request to issue an insurance policy. ## JSON Example { "contextId": "3561319f267fd53380bc38c049a01c8089876e833a321860766d35a9c40b67df", "insurancePolicy": { "policyName": "Mr. Bret Lees Policy", "policyNumber": "Policy-Bret-OneYear", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-10-31" }, "transactionRecord": { "name": "New Policy" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } }, { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API or the Multiroot Issue Inurance Policy API is generated by the Create Insurance Quote API. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when issuing the policy. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the policy or quote that’s used to create the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to create the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.")\[\] | JSON structure that’s used to override transaction information. | Optional | 63.0 | # issueInsurancePolicy(policyId) Issue a specific insurance policy by providing the policy ID. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyIssueOutputRepresentation issueInsurancePolicy(String policyId) ## Parameters **policyId** - Type: String - ID of the insurance policy to issue. ## Return Value Type: [ConnectApi.InsurancePolicyIssueOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_issue_output.htm "Output representation for the issue or endorse policy response. Contains the transaction ID and any errors that occurred during the process.") ## Usage Use this method to issue a specific insurance policy. Issuing a policy transitions it from a draft or pending state to an active state. The response includes the transaction ID and any errors that occurred during the issue process. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.issueInsurancePolicy() method to issue a specific insurance policy. **Class Definition** This Apex example shows how to issue an insurance policy. global class IssueConnectDriver { global static void callIssueConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); IssueTestConnectAPI callable = new IssueTestConnectAPI(); Object result = callable.call('issue', args); ConnectApi.InsurancePolicyIssueOutputRepresentation policyData = (ConnectApi.InsurancePolicyIssueOutputRepresentation) result; System.debug('Issue Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the IssueTestConnectAPI class to execute the issue action and process the result. public class IssueTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'issue') { String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to issue policy: ' + policyId); ConnectApi.InsurancePolicyIssueOutputRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.issueInsurancePolicy(policyId); System.debug('Policy issued successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while issuing policy: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute IssueConnectDriver.callIssueConnectAPI(); # IssuePolicy(IssuePolicyInput) Use the context ID provided in the input JSON to generate a new insurance policy. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyOutputRepresentation IssuePolicy(ConnectApi.IssuePolicyInputRepresentation IssuePolicyInput) ## Parameters **IssuePolicyInput** - Type: [ConnectApi.IssuePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_issue_policy.htm "Input representation of the request to issue an insurance policy.") - Input representation of the request to issue an insurance policy. ## Return Value Type: [ConnectApi.PolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_policy_output.htm "Output representation of the policy details.") # Limit Standing Option Input Input representation for limit standing options. ## Properties
Name Type Description Required or Optional Available Version
shouldInclude​PendingAmount Boolean Indicates whether to include the pending amount in the calculated output (true) or not (false).

The default value is false.

 Optional 65.0
viewOption String Filter values for coverages.

When a claimId is specified in the request, valid values are:

  • showAllPolicyCoverages—Retrieves all policy limits for the root insurance policy and all associated policy coverages. This provides a comprehensive view of all coverage terms.
  • showOpenClaimPolicyCoverages—(Default) Retrieves the policy limits that are associated with the open claim coverages. Additionally, the claim view includes all policy-level and claim-level limits, ensuring visibility into limits that impact the claim, even if no open coverage exists.

When a policyId is specified in the request, valid values are:

  • showAllPolicyCoverages—(Default)Retrieves all policy limit standings, regardless of whether the claim has open coverages. This option provides a full view of the policy's limits without restriction to active claims.
  • showPolicyLevelLimitsOnly—Retrieves policy limit standings at the policy and policy coverage level, but excludes limits that are associated with policy participants or policy assets. Use this option when only high-level policy limits are needed without participant or asset specific details.
Optional 65.0
# Lookup Error Code (POST) Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions. Use this resource when a product model validation error is encountered during setup and you need contextual troubleshooting guidance. Use this resource at design time to resolve an insurance error code such as SF-INS-DSAV-00001. Provide the error code string. The API matches it against registered insurance error codes and returns the description, optional cause, and resolution instructions. When the error code is known, the response includes the registered description and, when available, localized resolution instructions. When the error code isn’t registered, the API still returns HTTP status 200 with an informative “not found” description and format guidance in instructions. When required input is missing, errors can include request-level failures such as: - SF-INS-DSAV-00040 — the error code wasn’t specified. Provide a valid insurance error code. Returned with HTTP status 400 when errorCode is null, blank, or the request body is missing. Insufficient access, or Design Advisor not enabled for the org, returns HTTP status 403. An unexpected failure returns HTTP status 500. ## Resource /connect/insurance/design-advisor/error-code-lookup ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/error-code-lookup ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "errorCode": "SF-INS-DSAV-00023" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | The unique alphanumeric insurance error code identifier to look up. Must follow the SF-INS-XXX-NNNNN format, for example, SF-INS-DSAV-00023 and SF-INS-COM-00009. | Required | 68.0 | ## Response Body for POST [Insurance Lookup Error Code Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_lookup_error_code.htm "Response representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors.") # lookupErrorCode(insLookupErrorCodeInputRepresentation) Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions when a product model validation error is encountered during setup. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsLookupErrorCodeRepresentation lookupErrorCode(ConnectApi.InsLookupErrorCodeInputRepresentation insLookupErrorCodeInputRepresentation) ## Parameters insLookupErrorCodeInputRepresentation Type: [ConnectApi.InsLookup​Error​Code​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_lookup_error_code.htm "Input representation that specifies the insurance error code to look up.") Required. Input that specifies the insurance error code string to look up. ## Return Value Type: [ConnectApi.InsLookup​Error​Code​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_lookup_error_code.htm "Output representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors.") ## Usage Use this method at design time to resolve an insurance error code such as SF-INS-DSAV-00001. Provide the error code string. The method matches it against registered insurance error codes and returns the description, optional cause, and resolution instructions. When the error code is known, the response includes the registered description and, when available, localized resolution instructions. When the error code isn’t registered, the method still returns a result with an informative “not found” description and format guidance in instructions. When required input is missing, errors can include request-level failures such as: - SF-INS-DSAV-00040 — the error code wasn’t specified. Provide a valid insurance error code. ## Example This sample looks up an insurance error code from Apex. ConnectApi.InsLookupErrorCodeInputRepresentation input = new ConnectApi.InsLookupErrorCodeInputRepresentation(); input.errorCode = 'SF-INS-DSAV-00029'; ConnectApi.InsLookupErrorCodeRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.lookupErrorCode(input); System.debug('errorCode=' + result.errorCode); System.debug('errorDescription=' + result.errorDescription); System.debug('errorCause=' + result.errorCause); System.debug('instructions=' + result.instructions); System.debug('errors=' + result.errors); # mapCensusFields(censusId, groupCensusFieldMappingInputRepresentation) Map fields on an existing group census to the corresponding quote or contract records without creating new records. Use this method to remap references from quote records to contract records, or from contract records back to quote records, for example after a quote is converted to a contract. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.GroupCensusFieldMappingRepresentation mapCensusFields(String censusId, ConnectApi.GroupCensusFieldMappingInputRepresentation groupCensusFieldMappingInputRepresentation) ## Parameters **censusId** - Type: String - ID of the group census whose fields are mapped in place. **groupCensusFieldMappingInputRepresentation** - Type: [ConnectApi.GroupCensusFieldMappingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_group_census_field_mapping.htm "Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records.") - Filters and reference mapping rules that remap fields on the existing group census in place, without creating new records. ## Return Value Type: [ConnectApi.GroupCensusFieldMappingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_group_census_field_mapping.htm "Output representation that's returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") ## Usage Use this method to remap fields on an existing group census in place. Specify the census in censusId. All properties on the input representation are optional. To process only the member plans that belong to a quote, set quoteId on memberPlanFilter. Set exactly one mapping direction on memberPlanReferenceMapping: use contractId to remap quote line items to contract group plans, or quoteId to remap contract group plans back to quote line items. Don't set both. The method runs asynchronously and doesn't create new census records. Use the requestId in the response to track the job. Errors that occur while validating or scheduling the job are in the errors property. ## Example This example remaps quote line item references to the matching contract group plans. The groupCensusFilters block is optional and limits processing to member plans of one quote. Set exactly one of contractId or quoteId on memberPlanReferenceMapping to choose the mapping direction. // Remap quote line item references to the matching contract group plans. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String TARGET\_CONTRACT\_ID = '800xx000000gVN3AAM'; final String SOURCE\_QUOTE\_ID = '0Q0xx0000004C92CAE'; // Optional: limit processing to the member plans of one quote. ConnectApi.MemberPlanFilterInputRepresentation memberPlanFilter = new ConnectApi.MemberPlanFilterInputRepresentation(); memberPlanFilter.quoteId = SOURCE\_QUOTE\_ID; ConnectApi.GroupCensusFiltersInputRepresentation groupCensusFilters = new ConnectApi.GroupCensusFiltersInputRepresentation(); groupCensusFilters.memberPlanFilter = memberPlanFilter; // Required: exactly one of contractId / quoteId sets the mapping direction. ConnectApi.MemberPlanReferenceMappingInputRepresentation memberPlanReferenceMapping = new ConnectApi.MemberPlanReferenceMappingInputRepresentation(); memberPlanReferenceMapping.contractId = TARGET\_CONTRACT\_ID; ConnectApi.GroupCensusReferenceMappingsInputRepresentation groupCensusReferenceMappings = new ConnectApi.GroupCensusReferenceMappingsInputRepresentation(); groupCensusReferenceMappings.memberPlanReferenceMapping = memberPlanReferenceMapping; ConnectApi.GroupCensusFieldMappingInputRepresentation input = new ConnectApi.GroupCensusFieldMappingInputRepresentation(); input.groupCensusFilters = groupCensusFilters; input.groupCensusReferenceMappings = groupCensusReferenceMappings; try { ConnectApi.GroupCensusFieldMappingRepresentation result = ConnectApi.GroupBenefitsApi.mapCensusFields(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while mapping group census fields: ' + e.getMessage()); } This example uses the reverse direction. Set quoteId and omit contractId on memberPlanReferenceMapping to remap contract group plan references back to the matching quote line items. // Remap contract group plan references back to the matching quote line items. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String TARGET\_QUOTE\_ID = '0Q0xx0000004C92CAE'; ConnectApi.MemberPlanReferenceMappingInputRepresentation memberPlanReferenceMapping = new ConnectApi.MemberPlanReferenceMappingInputRepresentation(); memberPlanReferenceMapping.quoteId = TARGET\_QUOTE\_ID; // exactly one direction; do not also set contractId ConnectApi.GroupCensusReferenceMappingsInputRepresentation groupCensusReferenceMappings = new ConnectApi.GroupCensusReferenceMappingsInputRepresentation(); groupCensusReferenceMappings.memberPlanReferenceMapping = memberPlanReferenceMapping; ConnectApi.GroupCensusFieldMappingInputRepresentation input = new ConnectApi.GroupCensusFieldMappingInputRepresentation(); input.groupCensusReferenceMappings = groupCensusReferenceMappings; try { ConnectApi.GroupCensusFieldMappingRepresentation result = ConnectApi.GroupBenefitsApi.mapCensusFields(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while mapping group census fields: ' + e.getMessage()); } # Member Benefits Configuration Override (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. 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. ## Resource {rootQliId} is a placeholder. /connect/insurance/quote-line-items/{rootQliId}/overrides ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quote-line-items/0QLxx0000004CtoCAE/overrides ## Available Version 68.0 ## HTTP Methods POST, DELETE ## Path Parameter for POST and DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | rootQliId | String | ID of the root quote line item that the member overrides apply to. | Required | 68.0 | ## Request Parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | action | String | Override action to perform. Specify clone to copy overrides from sourceMemberId to the members listed in targetMemberIds. If not specified, the API upserts the overrides in the request body. | Optional | 68.0 | | sourceMemberId | String | ID of the group census member whose override configuration is cloned when action is clone. | Optional | 68.0 | ## Request Body for POST ### JSON Example { "contextId": "1cuxx0000004C92EAA", "overrides": \[ { "memberId": "0r6xx000000001aEAA", "operation": "UPSERT", "productId": "01txx0000004C92AAE", "quoteLineItemId": "0QLxx0000004CtoCAE", "attributes": \[ { "attributeId": "a0Axx0000004C92EAA", "attributeValue": "1500" } \] } \], "targetMemberIds": \[ "0r6xx000000002bEAA" \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | Optional context ID if the UI already configured the overrides. | Optional | 68.0 | | overrides | [Member Override Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_override_input.htm "Input representation of a single member override, including the member, product or quote line item, operation, and any overridden attributes.")\[\] | List of member overrides to apply. | Optional | 68.0 | | targetMemberIds | String\[\] | IDs of the group census members that receive the cloned override configuration. Use this property with the action=clone request parameter. | Optional | 68.0 | ## Response Body for POST [Member Overrides Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_member_overrides.htm "Output representation of the details that are returned after member overrides are upserted or cloned on a root quote line item. The response includes a success parameter to indicate if the operation is successful and any errors that occurred during processing if the operation didn't succeed.") ## Request Parameters for DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | memberId | String | ID of the group census member whose overrides are reverted on the root quote line item. | Required | 68.0 | ## Response Body for DELETE [Member Overrides Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_member_overrides.htm "Output representation of the details that are returned after member overrides are upserted or cloned on a root quote line item. The response includes a success parameter to indicate if the operation is successful and any errors that occurred during processing if the operation didn't succeed.") # Member Override Input Input representation of a single member override, including the member, product or quote line item, operation, and any overridden attributes. ## JSON Example { "memberId": "0r6xx000000001aEAA", "operation": "UPSERT", "productId": "01txx0000004C92AAE", "quoteLineItemId": "0QLxx0000004CtoCAE", "attributes": \[ { "attributeId": "a0Axx0000004C92EAA", "attributeValue": "1500" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Override Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_override_attribute_input.htm "Input representation of an attribute value to apply when you override a plan or coverage for a group census member.")\[\] | List of overridden attributes to apply to the plan or coverage. | Optional | 68.0 | | memberId | String | ID of the group census member that receives the override. | Optional | 68.0 | | operation | String | Type of override operation. Valid values are UPSERT and DELETE. | Optional | 68.0 | | productId | String | ID of the product associated with the coverage or plan being overridden. | Optional | 68.0 | | quoteLineItemId | String | ID of the quote line item for which a coverage is updated or deleted. | Optional | 68.0 | # Member Overrides Input Input representation of the member overrides to upsert or clone on a root quote line item, including an optional context ID and target member IDs for clone operations. ## JSON Example { "contextId": "1cuxx0000004C92EAA", "overrides": \[ { "memberId": "0r6xx000000001aEAA", "operation": "UPSERT", "productId": "01txx0000004C92AAE", "quoteLineItemId": "0QLxx0000004CtoCAE", "attributes": \[ { "attributeId": "a0Axx0000004C92EAA", "attributeValue": "1500" } \] } \], "targetMemberIds": \[ "0r6xx000000002bEAA" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | Optional context ID if the UI already configured the overrides. | Optional | 68.0 | | overrides | [Member Override Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_override_input.htm "Input representation of a single member override, including the member, product or quote line item, operation, and any overridden attributes.")\[\] | List of member overrides to apply. | Optional | 68.0 | | targetMemberIds | String\[\] | IDs of the group census members that receive the cloned override configuration. Use this property with the action=clone request parameter. | Optional | 68.0 | # Member Overrides Response Output representation of the details that are returned after member overrides are upserted or cloned on a root quote line item. The response includes a success parameter to indicate if the operation is successful and any errors that occurred during processing if the operation didn't succeed. ## JSON Example { "errors": \[\], "isSuccess": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while processing the member override request. | Big, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the process completed successfully (true) or not (false). | Big, 68.0 | 68.0 | # Member Plan Filter Input Input representation of the filter that identifies which group census member plan records to process. ## JSON Example { "quoteId": "0Q0xx0000004CtoCAE" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | quoteId | String | ID of the quote. The API processes only the member plans whose quote line item belongs to this quote. | Optional | 68.0 | # Member Plan Input Input representation of an insurance plan to add or update for a group census member. ## JSON Example { "contractGroupPlanId": "0gpxx0000000001AAA", "name": "Gold Tier Medical Plan", "attributes": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_attribute_input.htm "Input representation of an overridden attribute value on a group census member plan.")\[\] | Overridden attribute values to apply to this plan for the member. | Optional | 68.0 | | contractGroupPlanId | String | ID of the contract group plan the member is being enrolled into. Specify this property for on-contract coverage. For off-contract coverage, use productCode and rootProductCode instead. | Optional | 68.0 | | groupCensusMemberId | String | ID of the group census member the plan belongs to. | Optional | 68.0 | | id | String | ID of an existing group census member plan. Specify this property when you update an existing plan. | Required to update plan | 68.0 | | name | String | Name of the group census member plan. | Optional | 68.0 | | productCode | String | Product code of the off-contract coverage when no contract group plan ID is supplied. | Optional | 68.0 | | rootProductCode | String | Product code of the root product to which the off-contract coverage belongs. | Optional | 68.0 | # Member Plan Reference Mapping Input Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse. ## JSON Example { "contractId": "800xx0000004C92AAE", "quoteId": "0Q0xx0000004CtoCAE" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the contract. The API maps each member plan's quote line item reference to the matching contract group plan in this contract. | Optional | 68.0 | | quoteId | String | ID of the quote. The API maps each member plan's contract group plan reference to the matching quote line item in this quote. | Optional | 68.0 | # Member Policies Adjustment for Contract Endorsement (POST) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/policies/actions/apply-contract-adjustment ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/policies/actions/apply-contract-adjustment ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census whose eligible member policies are updated based on contract mid-term adjustment. | Required | 68.0 | ## Request Body for POST ### JSON Example { "flowName": "ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy", "shouldReprice": true } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to run to update member policies. The default value is the API name of the Apply Contract Adjustments to Member Policies flow: ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | ## Response Body for POST [Insurance Group Endorsement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_endorsement.htm "Output representation of the details that are returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") # Member With Plans Details Details for one group census member that was created or updated, including the member ID, associated plan IDs, and any member-level errors. ## JSON Example { "errors": \[\], "memberId": "0r6xx000000001aEAA", "memberPlans": \[ "0r8xx000000004kEAA", "0r8xx000000005lEAA" \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | Details about the errors that occurred while creating or updating the member or the member's plans. | Big, 68.0 | 68.0 | | memberId | String | ID of the group census member that was created or updated. | Big, 68.0 | 68.0 | | memberPlans | String\[\] | List of insurance plan IDs associated with the member. | Big, 68.0 | 68.0 | # Member With Plans Input Input representation of a group census member and the insurance plans to add or update for that member. ## JSON Example { "accountId": "001xx000003DGbqAAG", "firstName": "Alex", "lastname": "Taylor", "name": "Alex Taylor", "email": "alex.taylor@example.com", "memberType": "Primary", "associationWithPrimaryMbr": "Self", "relationshipToPrimaryMember": "Self", "birthdate": "1990-08-25", "groupClassName": "Full-Time Salaried", "sourceSystemIdentifier": "WD-EMP-67890", "status": "Active", "addedPlans": \[ { "contractGroupPlanId": "0gpxx0000000001AAA", "name": "Gold Tier Medical Plan" } \], "upsertedPlans": \[\], "deletedPlans": \[\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | Person account ID of the member. | Optional | 68.0 | | addedPlans | [Member Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_input.htm "Input representation of an insurance plan to add or update for a group census member.")\[\] | List of plans to assign to the member. | Optional | 68.0 | | additionalFields | Object | Additional custom (non-standard) fields to add to the group census member, specified by field API name. | Optional | 68.0 | | annualEligibleSalary | Double | Annual salary of the member that's eligible for benefits calculations. | Optional | 68.0 | | associationWithPrimaryMbr | String | Association to the primary member for dependents, such as Spouse or Child. | Optional | 68.0 | | birthdate | String | Date of birth of the member, in YYYY-MM-DD format. | Optional | 68.0 | | city | String | City of the member's address. | Optional | 68.0 | | contactId | String | ID of the contact record of the member. | Optional | 68.0 | | country | String | Country of the member's address. | Optional | 68.0 | | deletedPlans | String\[\] | List of insurance plan IDs to remove for this member. | Optional | 68.0 | | dependentCount | Integer | Number of dependents that are associated with the member. | Optional | 68.0 | | email | String | Email address of the member. | Optional | 68.0 | | firstName | String | First name of the member. | Required to add member | 68.0 | | fullTimeEquivalent | Double | Work capacity of the member, where 1.0 indicates a full-time employee. | Optional | 68.0 | | gender | String | Gender of the member. | Optional | 68.0 | | groupCensusId | String | ID of the group census that the member belongs to. | Optional | 68.0 | | groupCensusMemberPlans | [Member Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_input.htm "Input representation of an insurance plan to add or update for a group census member.")\[\] | List of insurance plans associated with this member. | Optional | 68.0 | | groupClassId | String | ID of the class or category within the group that the member belongs to. | Optional | 68.0 | | groupClassName | String | Name of the group class. | Optional | 68.0 | | grpCensusGrpClassSummaryId | String | ID of the related group census group class summary record. | Optional | 68.0 | | id | String | ID of the group census member whose details and associated insurance plans you want to add or update. | Required to update member | 68.0 | | isOptOutAllPlans | Boolean | Indicates whether the member has opted out of all available insurance plans (true) or not (false). | Optional | 68.0 | | isPortalUser | Boolean | Indicates whether a community portal user must be created for this member (true) or not (false). | Optional | 68.0 | | joinDate | String | Date the member joined the group or company. | Optional | 68.0 | | lastname | String | Last name of the member. | Required to add member | 68.0 | | memberKey | String | Unique, externally defined key that's used to identify and prevent duplicate members, often created by concatenating several fields. | Optional | 68.0 | | memberType | String | Type of member, such as Primary or Dependent. | Optional | 68.0 | | name | String | Full name of the member. | Optional | 68.0 | | optOutPlanTypes | String | Types of plans the member has opted out of. | Optional | 68.0 | | overrideTypeConfiguration | String | Override configuration for the member that governs which plan overrides are permitted, such as Default, Override Attributes, or Override Plans and Attributes. | Optional | 68.0 | | phoneNumber | String | Phone number of the member. | Optional | 68.0 | | policyStartDate | String | Date when the member's policy coverage begins. | Optional | 68.0 | | postalCode | String | Postal or ZIP code of the member's address. | Optional | 68.0 | | primaryGroupCensusMemberId | String | ID of the primary group census member that the dependents are associated with. | Optional | 68.0 | | primaryMemberCategory | String | Category of the primary member. | Optional | 68.0 | | primaryMemberSource | String | System or source from which the member's data originated. | Optional | 68.0 | | relationshipToPrimaryMember | String | Member's relationship to the primary insured. | Optional | 68.0 | | smokerStatus | String | Smoking status of the member, such as Smoker or Non-smoker. | Optional | 68.0 | | sourceSystemIdentifier | String | ID from an external source system, used for integration. | Optional | 68.0 | | state | String | State or province the member belongs to. | Optional | 68.0 | | status | String | Current status of the member, such as Active or Inactive. | Optional | 68.0 | | street | String | Street address of the member. | Optional | 68.0 | | upsertedPlans | [Member Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_input.htm "Input representation of an insurance plan to add or update for a group census member.")\[\] | List of existing insurance plans to add or update for this member. | Required for PATCH operation | 68.0 | # Members Plans Output representation for a list of members with their eligible plans. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | values | [Insurance Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_member_plans_output.htm "Output representation of the Insurance Get Member Plans service for an individual member.")\[\] | List of members (primary and dependent) and their associated eligible plans or errors. | Small, 65.0 | 65.0 | # Members With Plans Input Input representation of a family of group census members and their plans to add or update, including optional duplicate-detection fields, a processing flow, and configuration-rule settings. ## JSON Example { "duplicateDetectionFields": \[ "FirstName", "LastName", "Email" \], "flowName": "Process Group Census Member Data", "shouldExecuteConfigurationRule": false, "members": \[ { "firstName": "Alex", "lastname": "Taylor", "email": "alex.taylor@example.com", "memberType": "Primary", "associationWithPrimaryMbr": "Self", "relationshipToPrimaryMember": "Self", "sourceSystemIdentifier": "WD-EMP-67890", "groupClassName": "Full-Time Salaried", "addedPlans": \[ { "contractGroupPlanId": "0gpxx0000000001AAA", "name": "Gold Tier Medical Plan", "attributes": \[ { "attributeCode": "COVERAGE\_TIER", "attributeValue": "Family" } \] } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | duplicateDetectionFields | String\[\] | List of field API names that are used with the default fields to generate a unique key for identifying duplicate members. The default fields are FirstName, LastName, AssociationWithPrimaryMbr, Email, and GroupCensusId. | Optional | 68.0 | | flowName | String | Name of the flow to use for processing group census member data. The default value is Process Group Census Member Data. | Optional | 68.0 | | members | [Member With Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_with_plans_input.htm "Input representation of a group census member and the insurance plans to add or update for that member.")\[\] | List of group census members with their plan details to add or update. | Required | 68.0 | | shouldExecuteConfigurationRule | Boolean | Indicates whether the flow runs the eligibility and configurator engine when validating the submitted plans (true) or saves the submitted plans as-is (false). The default value is false. | Optional | 68.0 | # Members With Plans Response Details returned after a family of group census members and their plans is added or updated. The response includes a success flag, top-level errors, and per-member results. ## JSON Example { "errors": \[\], "isSuccess": true, "members": \[ { "errors": \[\], "memberId": "0r6xx000000001aEAA", "memberPlans": \[ "0r8xx000000004kEAA" \] }, { "errors": \[\], "memberId": "0r6xx000000002bEAA", "memberPlans": \[ "0r8xx000000005lEAA" \] } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of top-level errors. This list doesn't include member-specific error details. The list is empty when isSuccess is true. | Big, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the process completed successfully (true) or not (false). | Big, 68.0 | 68.0 | | members | [Member With Plans Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_member_with_plans.htm "Details for one group census member that was created or updated, including the member ID, associated plan IDs, and any member-level errors.")\[\] | Details of the individual members and their plans. | Big, 68.0 | 68.0 | # Multi-Root Policy Asynchronous Response Details of the multi-root policy that's processed asynchronously. ## JSON Example { "error": { "detail": "Error detail message.", "errors": \[ { "code": "ERROR\_CODE", "message": "Error message." } \], "instance": "Instance info", "title": "Error Title" }, "jobIdentifier": "08Pxx0000000001EAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Output](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_output.htm "Output representation of the error details.") | List of errors that occurred during the processing of the API request. | Small, 66.0 | 66.0 | | jobIdentifier | String | ID of the asynchronous job that's generated to process the multi-root policy along with its child policies. | Small, 66.0 | 66.0 | # Multi-Root Policy Endorsement (POST) Asynchronously endorse a multi-root insurance policy along with its child policies. If you want to calculate billing during multi-root insurance policy endorsement, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/multi-root/endorse ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx00000000WHGAY/multi-root/endorse ## Available Version 66.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the policy that must be endorsed along with its associated child policies. | Required | 66.0 | ## Request Body for POST ### JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "effectiveDate": "2024-01-01", "insurancePolicy": { "policyName": "p2\_endorse\_name", "policyNumber": "p2\_endorse\_number" }, "transactionRecord": { "name": "New Endorsement" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields": { "additionalFieldsList": \[ { "additionalFieldsMapValue": { "instanceKey": "autoRoot", "fields": { "Checkbox\_\_c": "true", "Currency\_\_c": 123456, "Date\_\_c": "2024-11-30", "DateTime\_\_c": "2024-12-31T01:34:00.000Z", "Email\_\_c": "testuser@sf.com" } } }, { "additionalFieldsMapValue": { "instanceKey": "autoDriver", "fields": { "TextEncr\_\_c": "233345675676", "Url\_\_c": "https://thisistest.com", "Time\_\_c": "12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.") \[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when endorsing the policy. | Optional | 67.0 | | contextId | String | Context ID of the quote that’s used for endorsement. | Required | 63.0 | | effectiveDate | String | Date from when the endorsed policy version is effective. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.") \[\] | JSON structure that overrides the name and policy number of the endorsed policy version. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that overrides the transaction information. | Optional | 63.0 | ## Response Body for POST [Multi-Root Policy Asynchronous Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_async.htm "Details of the multi-root policy that's processed asynchronously.") # Multi-Root Policy Issuance (POST) Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy. If you want to calculate billing during multi-root insurance policy issuance process, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource /connect/insurance/policies/multi-root ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/multi-root ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextId": "3561319f267fd53380bc38c049a01c8089876e833a321860766d35a9c40b67df", "insurancePolicy": { "policyName": "Mr. Bret Lees Policy", "policyNumber": "Policy-Bret-OneYear", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-10-31" }, "transactionRecord": { "name": "New Policy" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } }, { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API or the Multiroot Issue Inurance Policy API is generated by the Create Insurance Quote API. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when issuing the policy. | Required if Career Billing is enabled in your org | 67.0 | | contextId | String | Context ID of the policy or quote that’s used to create the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to create the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that’s used to override transaction information. | Optional | 63.0 | ## Response Body for POST [Multi-Root Policy Asynchronous Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_async.htm "Details of the multi-root policy that's processed asynchronously.") # Multi-Root Policy Renewal (POST) Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. If you want to calculate billing during multi-root insurance policy renewal process, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/multi-root/renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx00000000WHGAY/multi-root/renew ## Available Version 66.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | policyId | String | ID of the policy that must be renewed along with its associated child policies. | Required | ## Request Body for POST ### JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "insurancePolicy": { "policyName": "Demo Test Policy 9", "policyNumber": "test renew policy", "effectiveFromDate": "2025-03-15", "effectiveToDate": "2026-03-15" }, "transactionRecord":{ "name": "Renew Payment" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } } { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when renewing the policy. | Optional | 67.0 | | contextId | String | Priced context ID of the policy or quote that's used to renew the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that's used to override the transaction information. | Optional | 63.0 | ## Response Body for POST [Multi-Root Policy Asynchronous Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_async.htm "Details of the multi-root policy that's processed asynchronously.") # MultiRootEndorsePolicy(EndorsePolicyInput, policyId) Resource for the Insurance Multi Root Endorsement Policy Connect API POST Method. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyAsyncRepresentation MultiRootEndorsePolicy(ConnectApi.EndorsePolicyInputRepresentation EndorsePolicyInput, String policyId) ## Parameters **EndorsePolicyInput** - Type: [ConnectApi.EndorsePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_endorse_policy.htm "Input representation of the request to endorse a policy. Context ID of the quote that’s used for endorsement and date that the endorsed policy version is effective from must be passed in the request.") - Details to endorse the multi-root insurance policy along with its child policies. **policyId** - Type: String - ID of the insurance policy that must be endorsed along with its child policies. ## Return Value Type: [ConnectApi.PolicyAsyncRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_multi_root_renew_policy_async_output.htm "Output representation for multi-root policy renewal asynchronous operations.") ## Example This is a sample code that calls the Multi-Root Policy Endorsement API from Apex. public with sharing class MultiRootPolicyEndorsement implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'multiRootEndorsePolicy') { System.debug('Start of connect API call to multi-root endorse policy'); // Get input parameters from the input map String contextId = (String) inputMap.get('contextId'); String policyId = (String) inputMap.get('policyId'); String policyName = (String) inputMap.get('policyName'); String policyNumber = (String) inputMap.get('policyNumber'); String effectiveDate = (String) inputMap.get('effectiveDate'); String transactionName = (String) inputMap.get('transactionName'); Map additionalFields = (Map) inputMap.get('additionalFields'); System.debug('Context ID: ' + contextId); System.debug('Policy ID: ' + policyId); System.debug('Policy Name: ' + policyName); System.debug('Policy Number: ' + policyNumber); System.debug('Effective Date: ' + effectiveDate); System.debug('Transaction Name: ' + transactionName); System.debug('Additional Fields: ' + additionalFields); // Initialize the job identifier String jobIdentifier = null; // Validate required parameters if (String.isBlank(contextId)) { System.debug('ERROR: Context ID is required'); outputMap.put('error', 'Context ID is required'); return null; } try { // Step 1: Create Multi-Root Policy Endorsement input using the provided context ID ConnectApi.EndorsePolicyInputRepresentation policyInput = new ConnectApi.EndorsePolicyInputRepresentation(); // Populate fields for InsurancePolicyInputRepresentation ConnectApi.InsurancePolicyInputRepresentation insurancePolicy = new ConnectApi.InsurancePolicyInputRepresentation(); // Set policy basic fields (all optional except contextId) if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(policyNumber)) { insurancePolicy.policyNumber = policyNumber; } policyInput.insurancePolicy = insurancePolicy; // Populate transaction record (optional) if (!String.isBlank(transactionName)) { ConnectApi.InsurancePolicyTransactionInputRepresentation transactionRecord = new ConnectApi.InsurancePolicyTransactionInputRepresentation(); transactionRecord.name = transactionName; policyInput.transactionRecord = transactionRecord; } // Use the provided context ID (REQUIRED) policyInput.contextId = contextId; // Use the provided Effective Date (REQUIRED) policyInput.effectiveDate = effectiveDate; // Populate additional fields for child policies if (additionalFields != null && !additionalFields.isEmpty()) { System.debug('Processing additional fields for child policies'); policyInput.additionalFields = buildAdditionalFieldsList(additionalFields); } // Step 2: Execute Multi-Root Policy Endorsement with the provided context ID System.debug('Executing Multi-Root Policy Endorsement with context ID: ' + contextId + ' policy ID:' + policyId); Id idPolicyId = Id.valueOf(policyId); // Call the Connect API - Multi-Root Endorsement is ASYNCHRONOUS and returns a job identifier ConnectApi.PolicyAsyncRepresentation endorseResult = ConnectApi.InsurancePolicyAdminFamily.multiRootEndorsePolicy(policyInput, idPolicyId); // Get the job identifier jobIdentifier = endorseResult.jobIdentifier; // Log success System.debug('Multi-root policy endorsement job started successfully. Job ID: ' + jobIdentifier); System.debug('Context: ' + contextId); if (!String.isBlank(policyName)) { System.debug('Policy Name: ' + policyName); } // Put the job identifier in the output map outputMap.put('jobIdentifier', jobIdentifier); outputMap.put('endorsementResult', endorseResult); } catch (Exception e) { System.debug('Error while executing multi-root policy endorsement: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); outputMap.put('error', e.getMessage()); } // Return the job identifier return jobIdentifier; } // If the action is not recognized, return null return null; } /\*\* \* Build additional fields list for multi-root policies \* Converts from Map structure to List \* \* Input structure: \* { \* "additionalFieldsList": \[ \* { \* "additionalFieldsMapValue": { \* "instanceKey": "AutoSilver", \* "fields": { "PolicyName": "James Auto Policy"} \* } \* } \* \] \* } \*/ private static List buildAdditionalFieldsList(Map additionalFieldsInput) { List fieldsList = new List(); // Get the additionalFieldsList array List additionalFieldsList = (List) additionalFieldsInput.get('additionalFieldsList'); if (additionalFieldsList != null && !additionalFieldsList.isEmpty()) { for (Object item : additionalFieldsList) { Map itemMap = (Map) item; Object mapValue = itemMap.get('additionalFieldsMapValue'); if (mapValue != null) { // Create ConnectApi.AdditionalFieldsMapValue instance ConnectApi.AdditionalFieldsMapValue fieldMapValue = new ConnectApi.AdditionalFieldsMapValue(); // Set the additionalFieldsMapValue property // This property accepts Object type which will be the Map containing instanceKey and fields fieldMapValue.additionalFieldsMapValue = mapValue; fieldsList.add(fieldMapValue); } } } return fieldsList; } } /\* \* USAGE EXAMPLE: \* Multi-Root Policy Endorsement with Additional Fields \*/ // Create instance of the callable class MultiRootPolicyEndorsement callable = new MultiRootPolicyEndorsement(); // Prepare the input arguments with additional fields Map input = new Map(); input.put('contextId', '0000000i18tq18g002917629263342460535451b25974898aae9a44aab48ef3c'); // REQUIRED - Replace with your context ID input.put('policyId', '0YTSM0000001MrJ4AU'); // REQUIRED - Replace with your policy ID input.put('policyName', 'James Multi-Root Policy'); input.put('policyNumber', 'James Multi-Root Policy'); input.put('referencePolicyNumber', 'James1234'); input.put('effectiveDate', '2025-08-30'); // REQUIRED input.put('transactionName', 'Endorsed Policy Transaction'); // Build additional fields for child policies // Structure matches the JSON payload exactly Map additionalFields = new Map(); List additionalFieldsList = new List(); // Child Policy 1: Auto Insurance Map autoPolicy = new Map(); Map autoMapValue = new Map(); autoMapValue.put('instanceKey', 'AutoSilver'); Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy'); autoFields.put('Name', 'James Auto Policy'); autoMapValue.put('fields', autoFields); autoPolicy.put('additionalFieldsMapValue', autoMapValue); additionalFieldsList.add(autoPolicy); // Child Policy 2: Health Insurance Map healthPolicy = new Map(); Map healthMapValue = new Map(); healthMapValue.put('instanceKey', 'FamilyHealth'); Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy'); healthFields.put('Name', 'James Medical Policy'); healthMapValue.put('fields', healthFields); healthPolicy.put('additionalFieldsMapValue', healthMapValue); additionalFieldsList.add(healthPolicy); additionalFields.put('additionalFieldsList', additionalFieldsList); input.put('additionalFields', additionalFields); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'multiRootEndorsePolicy' action Object result = callable.call('multiRootEndorsePolicy', args); // Check results System.debug('Job Identifier: ' + result); if (output.containsKey('error')) { System.debug('ERROR: ' + output.get('error')); } else if (output.containsKey('endorsementResult')) { System.debug('SUCCESS: Multi-root policy endorsement job started with ID: ' + output.get('jobIdentifier')); System.debug('This job will endorse the input policy and apply the changes using the context, with additional fields on parent and child policies.'); System.debug('Monitor this job ID for completion status.'); } # MultiRootIssuePolicy(IssuePolicyInput) Asynchronously create a multi-root insurance policy along with its child policies. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyAsyncRepresentation MultiRootIssuePolicy(ConnectApi.IssuePolicyInputRepresentation IssuePolicyInput) ## Parameters **IssuePolicyInput** - Type: [ConnectApi.IssuePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_issue_policy.htm "Input representation of the request to issue an insurance policy.") - Details to create the multi-root insurance policy. ## Return Value Type: [ConnectApi.PolicyAsyncRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_multi_root_renew_policy_async_output.htm "Output representation for multi-root policy renewal asynchronous operations.") ## Example This is a sample code that calls the Multi-Root Issue Policy API from Apex. public with sharing class MultiRootPolicyIssuance implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'multiRootIssuePolicy') { System.debug('Start of connect API call to multi-root issue policy'); // Get input parameters from the input map String contextId = (String) inputMap.get('contextId'); String policyName = (String) inputMap.get('policyName'); String policyNumber = (String) inputMap.get('policyNumber'); String referencePolicyNumber = (String) inputMap.get('referencePolicyNumber'); String effectiveFromDate = (String) inputMap.get('effectiveFromDate'); String effectiveToDate = (String) inputMap.get('effectiveToDate'); String transactionName = (String) inputMap.get('transactionName'); Map additionalFields = (Map) inputMap.get('additionalFields'); System.debug('Context ID: ' + contextId); System.debug('Policy Name: ' + policyName); System.debug('Policy Number: ' + policyNumber); System.debug('Reference Policy Number: ' + referencePolicyNumber); System.debug('Effective From Date: ' + effectiveFromDate); System.debug('Effective To Date: ' + effectiveToDate); System.debug('Transaction Name: ' + transactionName); System.debug('Additional Fields: ' + additionalFields); // Initialize the job identifier String jobIdentifier = null; // Validate required parameters if (String.isBlank(contextId)) { System.debug('ERROR: Context ID is required'); outputMap.put('error', 'Context ID is required'); return null; } try { // Step 1: Create Multi-Root Policy Issuance input using the provided context ID ConnectApi.IssuePolicyInputRepresentation policyInput = new ConnectApi.IssuePolicyInputRepresentation(); // Populate fields for InsurancePolicyInputRepresentation ConnectApi.InsurancePolicyInputRepresentation insurancePolicy = new ConnectApi.InsurancePolicyInputRepresentation(); // Set policy basic fields (all optional except contextId) if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(policyNumber)) { insurancePolicy.policyNumber = policyNumber; } if (!String.isBlank(referencePolicyNumber)) { insurancePolicy.referencePolicyNumber = referencePolicyNumber; } if (!String.isBlank(effectiveFromDate)) { insurancePolicy.effectiveFromDate = effectiveFromDate; } if (!String.isBlank(effectiveToDate)) { insurancePolicy.effectiveToDate = effectiveToDate; } policyInput.insurancePolicy = insurancePolicy; // Populate transaction record (optional) if (!String.isBlank(transactionName)) { ConnectApi.InsurancePolicyTransactionInputRepresentation transactionRecord = new ConnectApi.InsurancePolicyTransactionInputRepresentation(); transactionRecord.name = transactionName; policyInput.transactionRecord = transactionRecord; } // Use the provided context ID (REQUIRED) policyInput.contextId = contextId; // Populate additional fields for child policies if (additionalFields != null && !additionalFields.isEmpty()) { System.debug('Processing additional fields for child policies'); policyInput.additionalFields = buildAdditionalFieldsList(additionalFields); } // Step 2: Execute Multi-Root Policy Issuance with the provided context ID System.debug('Executing Multi-Root Policy Issuance with context ID: ' + contextId); // Call the Connect API - Multi-Root Issuance is ASYNCHRONOUS and returns a job identifier ConnectApi.PolicyAsyncRepresentation issuanceResult = ConnectApi.InsurancePolicyAdminFamily.multiRootIssuePolicy(policyInput); // Get the job identifier jobIdentifier = issuanceResult.jobIdentifier; // Log success System.debug('Multi-root policy issuance job started successfully. Job ID: ' + jobIdentifier); System.debug('Context: ' + contextId); if (!String.isBlank(policyName)) { System.debug('Policy Name: ' + policyName); } // Put the job identifier in the output map outputMap.put('jobIdentifier', jobIdentifier); outputMap.put('issuanceResult', issuanceResult); } catch (Exception e) { System.debug('Error while executing multi-root policy issuance: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); outputMap.put('error', e.getMessage()); } // Return the job identifier return jobIdentifier; } // If the action is not recognized, return null return null; } /\*\* \* Build additional fields list for multi-root policies \* Converts from Map structure to List \* \* Input structure: \* { \* "additionalFieldsList": \[ \* { \* "additionalFieldsMapValue": { \* "instanceKey": "AutoSilver", \* "fields": { "PolicyName": "James Auto Policy"} \* } \* } \* \] \* } \*/ private static List buildAdditionalFieldsList(Map additionalFieldsInput) { List fieldsList = new List(); // Get the additionalFieldsList array List additionalFieldsList = (List) additionalFieldsInput.get('additionalFieldsList'); if (additionalFieldsList != null && !additionalFieldsList.isEmpty()) { for (Object item : additionalFieldsList) { Map itemMap = (Map) item; Object mapValue = itemMap.get('additionalFieldsMapValue'); if (mapValue != null) { // Create ConnectApi.AdditionalFieldsMapValue instance ConnectApi.AdditionalFieldsMapValue fieldMapValue = new ConnectApi.AdditionalFieldsMapValue(); // Set the additionalFieldsMapValue property // This property accepts Object type which will be the Map containing instanceKey and fields fieldMapValue.additionalFieldsMapValue = mapValue; fieldsList.add(fieldMapValue); } } } return fieldsList; } } /\* \* USAGE EXAMPLE: \* Multi-Root Policy Issuance with Additional Fields \*/ // Create instance of the callable class MultiRootPolicyIssuance callable = new MultiRootPolicyIssuance(); // Prepare the input arguments with additional fields Map input = new Map(); input.put('contextId', ); // REQUIRED - Replace with your context ID input.put('policyName', 'James Multi-Root Policy'); input.put('policyNumber', 'James Multi-Root Policy'); input.put('referencePolicyNumber', 'James1234'); input.put('effectiveFromDate', '2026-01-01'); input.put('effectiveToDate', '2026-10-31'); input.put('transactionName', 'Sold Policy Transaction'); // Build additional fields for child policies // Structure matches the JSON payload exactly Map additionalFields = new Map(); List additionalFieldsList = new List(); // Child Policy 1: Auto Insurance Map autoPolicy = new Map(); Map autoMapValue = new Map(); autoMapValue.put('instanceKey', ); Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy'); autoFields.put('Name', 'James Auto Policy'); autoMapValue.put('fields', autoFields); autoPolicy.put('additionalFieldsMapValue', autoMapValue); additionalFieldsList.add(autoPolicy); // Child Policy 2: Health Insurance Map healthPolicy = new Map(); Map healthMapValue = new Map(); healthMapValue.put('instanceKey', ); Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy'); healthFields.put('Name', 'James Medical Policy'); healthMapValue.put('fields', healthFields); healthPolicy.put('additionalFieldsMapValue', healthMapValue); additionalFieldsList.add(healthPolicy); additionalFields.put('additionalFieldsList', additionalFieldsList); input.put('additionalFields', additionalFields); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'multiRootIssuePolicy' action Object result = callable.call('multiRootIssuePolicy', args); // Check results System.debug('Job Identifier: ' + result); if (output.containsKey('error')) { System.debug('ERROR: ' + output.get('error')); } else if (output.containsKey('jobIdentifier')) { System.debug('SUCCESS: Multi-root policy issuance job started with ID: ' + output.get('jobIdentifier')); System.debug('This job will create a parent policy and child policies for Auto and Health insurance.'); System.debug('Monitor this job ID for completion status.'); } # MultiRootRenewPolicy(RenewPolicyInput, policyId) Asynchronouly renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. Use the priced context ID for the renewal process. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyAsyncRepresentation MultiRootRenewPolicy(ConnectApi.RenewPolicyInputRepresentation RenewPolicyInput, String policyId) ## Parameters **RenewPolicyInput** - Type: [ConnectApi.RenewPolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_renew_policy.htm "Input representation of the request to renew a policy.") - Input representation of the request to renew an existing multi-root policy. **policyId** - Type: String - ID of the multi-root policy that must be renewed along with its child policies. ## Return Value Type: [ConnectApi.PolicyAsyncRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_multi_root_renew_policy_async_output.htm "Output representation for multi-root policy renewal asynchronous operations.") ## Example This is a sample code that calls the Multi-Root Policy Renewal API from Apex. public with sharing class MultiRootPolicyRenewal implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'multiRootRenewPolicy') { System.debug('Start of connect API call to multi-root renew policy'); // Get input parameters from the input map String contextId = (String) inputMap.get('contextId'); String policyId = (String) inputMap.get('policyId'); String policyName = (String) inputMap.get('policyName'); String policyNumber = (String) inputMap.get('policyNumber'); String effectiveFromDate = (String) inputMap.get('effectiveFromDate'); String effectiveToDate = (String) inputMap.get('effectiveToDate'); String transactionName = (String) inputMap.get('transactionName'); Map additionalFields = (Map) inputMap.get('additionalFields'); System.debug('Context ID: ' + contextId); System.debug('Policy ID: ' + policyId); System.debug('Policy Name: ' + policyName); System.debug('Policy Number: ' + policyNumber); System.debug('Effective From Date: ' + effectiveFromDate); System.debug('Effective To Date: ' + effectiveToDate); System.debug('Transaction Name: ' + transactionName); System.debug('Additional Fields: ' + additionalFields); // Initialize the job identifier String jobIdentifier = null; // Validate required parameters if (String.isBlank(contextId)) { System.debug('ERROR: Context ID is required'); outputMap.put('error', 'Context ID is required'); return null; } if (String.isBlank(policyId)) { System.debug('ERROR: Policy ID is required'); outputMap.put('error', 'Policy ID is required'); return null; } try { // Step 1: Create Multi-Root Policy Renewal input using the provided context ID ConnectApi.RenewPolicyInputRepresentation renewalInput = new ConnectApi.RenewPolicyInputRepresentation(); // Use the provided context ID (REQUIRED) renewalInput.contextId = contextId; // Populate fields for InsurancePolicyInputRepresentation (nested object) ConnectApi.InsurancePolicyInputRepresentation insurancePolicy = new ConnectApi.InsurancePolicyInputRepresentation(); // Set policy basic fields (all optional) if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(policyNumber)) { insurancePolicy.policyNumber = policyNumber; } // Set effective dates on the insurancePolicy object (not on renewalInput directly) if (!String.isBlank(effectiveFromDate)) { insurancePolicy.effectiveFromDate = effectiveFromDate; } if (!String.isBlank(effectiveToDate)) { insurancePolicy.effectiveToDate = effectiveToDate; } // Only set insurancePolicy if any fields were set if (!String.isBlank(policyName) || !String.isBlank(policyNumber) || !String.isBlank(effectiveFromDate) || !String.isBlank(effectiveToDate)) { renewalInput.insurancePolicy = insurancePolicy; } // Populate transaction record (optional) if (!String.isBlank(transactionName)) { ConnectApi.InsurancePolicyTransactionInputRepresentation transactionRecord = new ConnectApi.InsurancePolicyTransactionInputRepresentation(); transactionRecord.name = transactionName; renewalInput.transactionRecord = transactionRecord; } // Populate additional fields for child policies if (additionalFields != null && !additionalFields.isEmpty()) { System.debug('Processing additional fields for child policies'); renewalInput.additionalFields = buildAdditionalFieldsList(additionalFields); } // Step 2: Execute Multi-Root Policy Renewal with the provided context ID and policy ID System.debug('Executing Multi-Root Policy Renewal with context ID: ' + contextId + ' and policy ID: ' + policyId); // Call the Connect API - Multi-Root Renewal is ASYNCHRONOUS and returns a job identifier // NOTE: Parameter order is INPUT first, then policyId ConnectApi.PolicyAsyncRepresentation renewalResult = ConnectApi.InsurancePolicyAdminFamily.multiRootRenewPolicy(renewalInput, policyId); // Get the job identifier jobIdentifier = renewalResult.jobIdentifier; // Log success System.debug('Multi-root policy renewal job started successfully. Job ID: ' + jobIdentifier); System.debug('Context: ' + contextId); System.debug('Policy ID: ' + policyId); // Put the job identifier in the output map outputMap.put('jobIdentifier', jobIdentifier); outputMap.put('renewalResult', renewalResult); } catch (Exception e) { System.debug('Error while executing multi-root policy renewal: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); outputMap.put('error', e.getMessage()); } // Return the job identifier return jobIdentifier; } // If the action is not recognized, return null return null; } /\*\* \* Build additional fields list for multi-root policies \* Converts from Map structure to List \* \* Input structure: \* { \* "additionalFieldsList": \[ \* { \* "additionalFieldsMapValue": { \* "instanceKey": "AutoSilver", \* "fields": { "EffectiveFromDate": "2025-01-01", "EffectiveToDate": "2026-01-01"} \* } \* } \* \] \* } \*/ private static List buildAdditionalFieldsList(Map additionalFieldsInput) { List fieldsList = new List(); // Get the additionalFieldsList array List additionalFieldsList = (List) additionalFieldsInput.get('additionalFieldsList'); if (additionalFieldsList != null && !additionalFieldsList.isEmpty()) { for (Object item : additionalFieldsList) { Map itemMap = (Map) item; Object mapValue = itemMap.get('additionalFieldsMapValue'); if (mapValue != null) { // Create ConnectApi.AdditionalFieldsMapValue instance ConnectApi.AdditionalFieldsMapValue fieldMapValue = new ConnectApi.AdditionalFieldsMapValue(); // Set the additionalFieldsMapValue property // This property accepts Object type which will be the Map containing instanceKey and fields fieldMapValue.additionalFieldsMapValue = mapValue; fieldsList.add(fieldMapValue); } } } return fieldsList; } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ // Create instance of the callable class MultiRootPolicyRenewal callable = new MultiRootPolicyRenewal(); // Build additional fields for child policies // Structure matches the JSON payload exactly Map additionalFields = new Map(); List additionalFieldsList = new List(); // Child Policy 1: Auto Insurance Map autoPolicy = new Map(); Map autoMapValue = new Map(); autoMapValue.put('instanceKey', 'AutoSilver'); Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy'); autoFields.put('Name', 'James Auto Policy'); autoMapValue.put('fields', autoFields); autoPolicy.put('additionalFieldsMapValue', autoMapValue); additionalFieldsList.add(autoPolicy); // Child Policy 2: Health Insurance Map healthPolicy = new Map(); Map healthMapValue = new Map(); healthMapValue.put('instanceKey', 'FamilyHealth'); Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy'); healthFields.put('Name', 'James Medical Policy'); healthMapValue.put('fields', healthFields); healthPolicy.put('additionalFieldsMapValue', healthMapValue); additionalFieldsList.add(healthPolicy); additionalFields.put('additionalFieldsList', additionalFieldsList); input.put('additionalFields', additionalFields); // Prepare the input arguments - WITH ADDITIONAL FIELDS Map input = new Map(); input.put('contextId', ); // REQUIRED input.put('policyId', ); // REQUIRED input.put('effectiveFromDate', '2026-01-01'); // Optional input.put('effectiveToDate', '2027-01-01'); // Optional input.put('policyName', 'Renewed Multi-Root Policy'); input.put('transactionName', 'Multi-Root Annual Renewal with Updates'); input.put('additionalFields', additionalFields); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'multiRootRenewPolicy' action Object result = callable.call('multiRootRenewPolicy', args); // Check results if (output.containsKey('error')) { System.debug('ERROR: ' + output.get('error')); } else if (output.containsKey('jobIdentifier')) { String jobId = (String) output.get('jobIdentifier'); System.debug('SUCCESS: Multi-root renewal job started with Job ID: ' + jobId); System.debug('Use this job ID to track the renewal progress'); } # Networks Input Represents Insurance Policy Coverage Networks for creating plan benefits. ## JSON Example { "networks": \[ { "network": "First Network Tier", "name": "Preferred Network Updated" }, { "network": "Second Network Tier", "name": "In Network Updated" }, { "network": "Third Network Tier", "name": "Out Network" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | name | String | The name of the network. | Required | 63.0 | | network | String | Tier type of the network. | Required | 63.0 | # Open Claim Coverage Action Open a claim coverage. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/openClaimCoverage Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | openClaimCoverageInputRep | Apex-defined | Required. An Apex [ConnectApi.OpenClaimCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_open_claim_coverage_input_re.htm "Input representation for the open claim coverage action.") record that contains the details of the claim coverage to be opened. | ## Outputs | Output | Type | Description | | --- | --- | --- | | coverageId | string | ID of the claim coverage that's opened. | ## Example Sample Request { "inputs": \[ { "openClaimCoverageInputRep": { "claimParticipantId": "0kaxx000000001dEAA", "claimItemId": "0koxx000000001dEAA", "insurancePolicyAssetId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "reserveProcessingMode": "Manual", "currencyIsoCode": "USD", "lossReserveAmount": 5000, "expenseReserveAmount": 750.5, "additionalFields": { "RequireInspection": true, "CoverageSubtype": "Collision-Standard" } } } \] } Sample Response \[ { "actionName": "openClaimCoverage", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "coverageId": "1ccS70000004oVfIAI" }, "sortOrder": -1, "version": 1 } \] # Out-of-Sequence Endorse Policy Output representation of the details for the out of sequence policy endorsement process. ## JSON Example { "error": \[ { "detail": "Looks like you don't have access to this feature. Your Salesforce admin can help with that.", "errors": \[ { "code": "INTERNAL\_ERROR", "message": "Something went wrong. Try again later or contact your Salesforce admin for help." } \], "instance": "", "title": "Access Denied" } \], "jobIdentifier": "15Uxx0000004CUWEA2" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_output.htm "Output representation of the error details.")\[\] | Error details when the out-of-sequence endorsement operation fails. | Small, 65.0 | 65.0 | | jobIdentifier | String | ID of the job that's created for the out-of-sequence endorsement process. | Small, 65.0 | 65.0 | # Out-of-Sequence Endorse Policy (POST) Create an out-of-sequence endorsement for an insurance policy. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/out-of-sequence-endorsement ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA/out-of-sequence-endorsement ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the insurance policy to create the out-of-sequence endorsement for. | Required | 65.0 | ## Request Body for POST ### JSON Example { "contextId": "0000000i18tq18g00291750179239892137c4250a82940e49987f6d97559b4de", "effectiveDate": "2025-03-05", "insurancePolicy": { "policyName": "Life Insurance", "policyNumber": "LI000aax8967245gj" }, "fieldSetIds": { "policyFieldSetId": "0IXxx0000004CYqGAM", "assetFieldSetId": "0IXxx0000004CaSGAU", "participantFieldSetId": "0IXxx0000004CdgGAE", "coverageFieldSetId": "0IXxx0000004Cc4GAE" }, "transactionRecord": { "name": "Custom OOSE transaction" } } ### Properties
Name Type Description Required or Optional Available Version
contextId String ID of the context that's used to create an endorsement policy version. Required 65.0
effectiveDate String Date from which the out-of-sequence endorsement applies. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the endorsement applies starting March 1, 2025, and the API re-rates the policy from 2025-03-01 forward.

Required 65.0
fieldSetIds Additional Fields Field Set Input [] Field set IDs of the additional fields that are associated with the insurance policy. Optional 65.0
insurancePolicy Insurance Policy Input [] Details of the insurance policy to create the out-of-sequence endorsement for.

It contains fields and values from the Insurance Policy object.

 Optional 65.0
transactionRecord Insurance Policy Transaction Input [] JSON structure that's used to override transaction information. Optional 65.0
## Response Body for POST [Out-Of-Sequence Endorse Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_out_of_sequence_endorse_policy.htm "Output representation of the details for the out of sequence policy endorsement process.") # Out-of-Sequence Endorse Policy Input Input representation of the details for creating the out-of-sequence endorsement. ## JSON Example { "contextId": "0000000i18tq18g00291750179239892137c4250a82940e49987f6d97559b4de", "effectiveDate": "2025-03-05", "insurancePolicy": { "policyName": "Life Insurance", "policyNumber": "LI000aax8967245gj" }, "fieldSetIds": { "policyFieldSetId": "0IXxx0000004CYqGAM", "assetFieldSetId": "0IXxx0000004CaSGAU", "participantFieldSetId": "0IXxx0000004CdgGAE", "coverageFieldSetId": "0IXxx0000004Cc4GAE" }, "transactionRecord": { "name": "Custom OOSE transaction" } } ## Properties
Name Type Description Required or Optional Available Version
contextId String ID of the context that's used to create an endorsement policy version. Required 65.0
effectiveDate String Date from which the out-of-sequence endorsement applies. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the endorsement applies starting March 1, 2025, and the API re-rates the policy from 2025-03-01 forward.

 Required 65.0
fieldSetIds Additional Fields Field Set Input[] Field set IDs of the additional fields that are associated with the insurance policy. Optional 65.0
insurancePolicy Insurance Policy Input[] Details of the insurance policy to create the out-of-sequence endorsement for.

It contains fields and values from the Insurance Policy object.

 Optional 65.0
transactionRecord Insurance Policy Transaction Input[] JSON structure that's used to override transaction information. Optional 65.0
# OutOfSequenceEndorsePolicy(OutOfSequenceEndorsePolicyInput, policyId) Create an out-of-sequence endorsement for an insurance policy. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.OutOfSequenceEndorsePolicyOutputRepresentation OutOfSequenceEndorsePolicy(ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation OutOfSequenceEndorsePolicyInput, String policyId) ## Parameters **OutOfSequenceEndorsePolicyInput** - Type: [ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_out_of_sequence_endorse_policy.htm "Input representation of the details to perform an out-of-sequence endorsement on an insurance policy.") - Details to create the out-of-sequence endorsement. **policyId** - Type: String - ID of the insurance policy to create the out-of-sequence endorsement for. ## Return Value Type: [ConnectApi.OutOfSequenceEndorsePolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_out_of_sequence_endorse_policy.htm "Output representation for out of sequence endorsement output representation.") ## Example Here's an example of how to invoke the Out-of-Sequence Policy API by using Apex. /\* \* Out of Sequence Policy Endorsement Service using Connect API \* \* IMPORTANT: Out-of-sequence endorsement is an asynchronous process and returns a job identifier \* for tracking the request. \*/ public with sharing class OutOfSequenceEndorsement implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'outOfSequenceEndorsePolicy') { System.debug('Start of connect API call to out of sequence endorse policy'); // Get input parameters from the input map String policyId = (String) inputMap.get('policyId'); String effectiveDate = (String) inputMap.get('effectiveDate'); String contextId = (String) inputMap.get('contextId'); System.debug('Policy ID: ' + policyId); System.debug('Effective Date: ' + effectiveDate); System.debug('Context ID: ' + contextId); // Initialize the job identifier String jobIdentifier = null; // Validate required parameters if (String.isBlank(policyId)) { System.debug('ERROR: Policy ID is required'); outputMap.put('error', 'Policy ID is required'); return null; } if (String.isBlank(effectiveDate)) { System.debug('ERROR: Effective Date is required'); outputMap.put('error', 'Effective Date is required'); return null; } if (String.isBlank(contextId)) { System.debug('ERROR: Context ID is required'); outputMap.put('error', 'Context ID is required'); return null; } try { // Step 1: Create OOSE input using the provided context ID ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation policyInput = new ConnectApi.OutOfSequenceEndorsePolicyInputRepresentation(); // Populate fields for InsurancePolicyInputRepresentation ConnectApi.InsurancePolicyInputRepresentation insurancePolicy = new ConnectApi.InsurancePolicyInputRepresentation(); insurancePolicy.policyName = 'Lisa Auto Policy'; insurancePolicy.policyNumber = 'Lisa Auto Policy'; policyInput.insurancePolicy = insurancePolicy; // Populate transaction record ConnectApi.InsurancePolicyTransactionInputRepresentation transactionRecord = new ConnectApi.InsurancePolicyTransactionInputRepresentation(); transactionRecord.name = 'Custom OOSE Transaction'; policyInput.transactionRecord = transactionRecord; // Set the effective date for the out of sequence endorsement policyInput.effectiveDate = effectiveDate; // Use the provided context ID policyInput.contextId = contextId; // Set field sets ConnectApi.AdditionalFieldsFieldSetInputRepresentation fieldSetIds = new ConnectApi.AdditionalFieldsFieldSetInputRepresentation(); fieldSetIds.policyFieldSetId = '0IXZM0000008P684AE'; // Replace with your policy field set ID fieldSetIds.assetFieldSetId = '0IXZM0000004DDC4A2'; // Replace with your asset field set ID fieldSetIds.participantFieldSetId = '0IXZM0000004DDH4A2'; // Replace with your participant field set ID fieldSetIds.coverageFieldSetId = '0IXZM0000008P6D4AU'; // Replace with your coverage field set ID policyInput.fieldSetIds = fieldSetIds; // Step 2: Execute OOSE with the provided context ID System.debug('Executing OOSE with context ID: ' + contextId); // Call the Connect API directly - OOSE is ASYNCHRONOUS and returns a job identifier ConnectApi.OutOfSequenceEndorsePolicyOutputRepresentation ooseResult = ConnectApi.InsurancePolicyAdminFamily.outOfSequenceEndorsePolicy(policyInput, policyId); // Get the job identifier jobIdentifier = ooseResult.jobIdentifier; // Log success System.debug('Out-of-sequence endorsement job started successfully. Job ID: ' + jobIdentifier); System.debug('Policy: ' + policyId + ' | Context: ' + contextId + ' | Effective Date: ' + effectiveDate); // Put the job identifier in the output map outputMap.put('jobIdentifier', jobIdentifier); outputMap.put('ooseResult', ooseResult); } catch (Exception e) { System.debug('Error while executing out-of-sequence endorsement: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the job identifier return jobIdentifier; } // If the action is not recognized, return null return null; } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ // Create instance of the callable class OutOfSequenceEndorsement callable = new OutOfSequenceEndorsement(); // Prepare the input arguments Map input = new Map(); input.put('policyId', '0YTxx00000000MbGAI'); // Replace with your policy ID input.put('effectiveDate', '2025-06-01'); // Replace with your desired effective date input.put('contextId', 'your-context-id-here'); // Replace with your context ID // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'outOfSequenceEndorsePolicy' action Object result = callable.call('outOfSequenceEndorsePolicy', args); // Retrieve the job identifier from the result String jobIdentifier = (String) result; // Output the job identifier to the debug log System.debug('Job Identifier: ' + jobIdentifier); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } else if (output.containsKey('jobIdentifier')) { System.debug('SUCCESS: OOSE job started with ID: ' + output.get('jobIdentifier')); System.debug('Monitor this job ID for completion status.'); } # Output Classes Most ConnectApi methods return instances of ConnectApi output classes. All properties are read-only, except for instances of output classes created within test code. All output classes are concrete unless marked abstract in this documentation. All concrete output classes have no-argument constructors that you can invoke only from test code. See [Testing ConnectApi Code](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_TestingApex.htm). Insurance Design Advisor includes these Apex output classes. - **[ConnectApi.InsAttributeValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_attribute_validation.htm)** Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn't. - **[ConnectApi.InsAttributeValidationResultRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_attribute_validation_result.htm)** Output representation of the validation result for one attribute lookup. The result includes the identifiers from the request and includes resolution guidance when the attribute definition can't be validated. - **[ConnectApi.InsCMLModelValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_cml_model_validation.htm)** Output representation of the per-record validation results and any top-level errors that occur when processing the request. - **[ConnectApi.InsCMLModelValidationResultRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_cml_model_validation_result.htm)** Output representation of the validation result for a single record. When the record isn’t valid, instructions describes the failure and recommended correction. - **[ConnectApi.InsGetRatingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_get_rating_input.htm)** Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails. - **[ConnectApi.InsLookupErrorCodeRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_lookup_error_code.htm)** Output representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors. - **[ConnectApi.InsPricingSetupValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_pricing_setup_validation.htm)** Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors. - **[ConnectApi.InsProductDiscoveryValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_discovery_validation.htm)** Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages. - **[ConnectApi.InsProductModelValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_model_validation.htm)** Output representation of the validation results for a product model and its hierarchy. - **[ConnectApi.InsProductHierarchyValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_hierarchy_validation.htm)** Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check. - **[ConnectApi.InsRequestValidationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_request_validation.htm)** Output representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation. - **[ConnectApi.InsRequestValidationResultRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_request_validation_result.htm)** Output representation of a single request validation finding. When the finding isn’t valid, instructions contains the issue and how to resolve it. - **[ConnectApi.InsValidateUserPermissionsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_validate_user_permissions.htm)** Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t. - **[ConnectApi.InsDesignAdvisorErrorDetailsOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_details_output.htm)** Output representation of the validation error of an attribute with the code and message. - **[ConnectApi.InsDesignAdvisorErrorResponseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_design_advisor_error_response.htm)** Output representation of an error returned by an Insurance Design Advisor validation. # Override Attribute Input Input representation of an attribute value to apply when you override a plan or coverage for a group census member. ## JSON Example { "attributeId": "a0Axx0000004C92EAA", "attributeValue": "1500", "picklistAttributeValueId": "a0Bxx0000004C92EAA" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeId | String | ID of the attribute definition to override. | Optional | 68.0 | | attributeValue | String | Value for the attribute to override. | Optional | 68.0 | | picklistAttributeValueId | String | ID of the picklist value to apply when the attribute is a picklist. | Optional | 68.0 | # patchInsuranceCheckPlansEligibility(plansEligibilityInputParamWithContextId, memberId) Check the eligibility of a group census member for a set of added and deleted plans within an existing context. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePlansEligibilityOutputRepresentation patchInsuranceCheckPlansEligibility(ConnectApi.InsurancePlansEligibilityPatchInputRepresentation plansEligibilityInputParamWithContextId, String memberId) ## Parameters **plansEligibilityInputParamWithContextId** - Type: [ConnectApi.InsurancePlansEligibilityPatchInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_plans_eligibility_patch.htm "Input representation for checking plan eligibility by updating an existing context.") - Input representation that contains the context ID and the plans that must be added or removed. **memberId** - Type: String - ID of the group census member whose eligibility must be checked. ## Return Value Type: [ConnectApi.InsurancePlansEligibilityOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plans_eligibility.htm "Output representation for the employee plan eligibility check.") ## Example // Plans Eligibility (PATCH) via Connect API // 1) Build the patch input ConnectApi.InsurancePlansEligibilityPatchInputRepresentation input = new ConnectApi.InsurancePlansEligibilityPatchInputRepresentation(); // Required: contextId from a prior eligibility session (POST response) input.contextId = '0000000i14tq18g00291764218838971ecb8e4a0905c434cbe3f9beeb9f0739e'; // Plans to add ConnectApi.InsuranceGroupPlanInputRepresentation addPlan = new ConnectApi.InsuranceGroupPlanInputRepresentation(); addPlan.planId = '0rgSG0000000fjBYAQ'; input.addedPlans = new List{ addPlan }; // Plans to remove ConnectApi.InsuranceGroupPlanInputRepresentation removePlan = new ConnectApi.InsuranceGroupPlanInputRepresentation(); removePlan.planId = '0rgSG0000000fUlYAI'; input.deletedPlans = new List{ removePlan }; // 2) Execute the PATCH with the same Group Census Member Id String memberId = '0r6SG00000091EbYAI'; try { ConnectApi.InsurancePlansEligibilityOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.patchInsuranceCheckPlansEligibility( input, memberId ); System.debug('Eligibility (PATCH) result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Eligibility (PATCH) error: ' + e.getMessage()); } # patchInsuranceUpdateCensus(updateCensusInputParam, contractId) Update a group census from policy enrollments and endorsements on an existing group benefits contract. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceRefreshCensusRepresentation patchInsuranceUpdateCensus(ConnectApi.InsuranceRefreshCensusInputRepresentation updateCensusInputParam, String contractId) ## Parameters **updateCensusInputParam** - Type: [ConnectApi.InsuranceRefreshCensusInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_refresh_census.htm "Input representation of the group census ID, date range, optional filters, and update options used to refresh a group census from policy enrollments and endorsements on a contract.") - Group census ID, date range, optional filters, and update options used to refresh the group census. **contractId** - Type: String - ID of the insurance contract whose policy enrollments and endorsements are used to update the group census. ## Return Value Type: [ConnectApi.InsuranceRefreshCensusRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_refresh_census.htm "Output representation that's returned when you start updating a group census from policy enrollments and endorsements on a group benefits contract.") ## Usage Use this method to update a group census from policy enrollments and endorsements on an existing group benefits contract. Specify the contract in contractId and the census in groupCensusId. Set startDate and endDate in yyyy-MM-dd format to define the enrollment and endorsement window. Set policyEffectiveDate in the same format to select the policy version. The date must fall between the version's effectiveFromDate and effectiveToDate. This method runs asynchronously and returns a requestId that you can use to track the job. To retry a failed run, pass that requestId with the same groupCensusId. Use filter to limit the update to root contract group plans, contacts, or person accounts. Set shouldGenerateCSV to create a CSV file of the updated census details. Set shouldIncludeMemberPlans to include insurance plan details for each member. To stamp additional field values on group census members, add items to groupCensusAdditionalFields. Check isSuccess, groupCensusId, and requestId on the response. Errors are in the errors property. ## Example This example starts updating a group census from a contract for a date range, filters by person account, stamps an additional census field, and includes member plan details and a CSV file. // Update a group census from policy enrollments and endorsements on a contract. final String CONTRACT\_ID = '800SB00001HNnddYAD'; // Optional: filter by members and/or root contract group plans. ConnectApi.InsuranceCensusFilterInputRepresentation filter = new ConnectApi.InsuranceCensusFilterInputRepresentation(); filter.objectName = 'PersonAccount'; filter.recordIds = new List{ '001SB00001wg2zZYAQ' }; // filter.contractGroupPlanIds = new List{ /\* optional: root contract group plan IDs \*/ }; ConnectApi.InsuranceApexStringRepresentation sourceSystem = new ConnectApi.InsuranceApexStringRepresentation(); sourceSystem.key = 'SourceSystemName'; sourceSystem.value = 'new'; ConnectApi.InsuranceRefreshCensusInputRepresentation input = new ConnectApi.InsuranceRefreshCensusInputRepresentation(); input.groupCensusId = '0rfSB000000505pYAA'; input.startDate = '2026-07-04'; input.endDate = '2026-08-10'; input.policyEffectiveDate = '2026-12-12'; input.shouldIncludeMemberPlans = true; input.shouldGenerateCSV = true; input.filter = filter; input.groupCensusAdditionalFields = new List{ sourceSystem }; // input.requestId = '08Pxx0000000001EAA'; // only to retry records that failed in a previous run try { ConnectApi.InsuranceRefreshCensusRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.patchInsuranceUpdateCensus(input, CONTRACT\_ID); System.debug('isSuccess: ' + result.isSuccess); System.debug('groupCensusId: ' + result.groupCensusId); System.debug('requestId: ' + result.requestId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while updating the census: ' + e.getMessage()); } # patchInsuranceUpdateMemberPlans(insuranceUpdateMemberPlansInput, memberId) Update the plans that are associated with a group census member. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceUpdateMemberPlansOutputRepresentation patchInsuranceUpdateMemberPlans(ConnectApi.InsuranceUpdateMemberPlansInputRepresentation insuranceUpdateMemberPlansInput, String memberId) ## Parameters **insuranceUpdateMemberPlansInput** - Type: [ConnectApi.InsuranceUpdateMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_update_member_plans.htm "Input representation for updating the plans for a group census member.") - Details to update the insurance plans for the census member. **memberId** - Type: String - ID of the group census member whose plans must be updated. ## Return Value Type: [ConnectApi.InsuranceUpdateMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_update_member_plans.htm "Output representation for the member plan update process.") ## Example Here's an example of how to invoke the Insurance Update Member Plans API from Apex code. // Update Member Plan(s) for a Group Census Member via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceUpdateMemberPlansInputRepresentation input = new ConnectApi.InsuranceUpdateMemberPlansInputRepresentation(); // 2) Plans to ADD (provide Contract Group Plan Ids to add) List added = new List(); ConnectApi.GroupCensusMemberPlanInputRepresentation addPlan1 = new ConnectApi.GroupCensusMemberPlanInputRepresentation(); addPlan1.contractGroupPlanId = '0rgxx000000003UAAQ'; // e.g., a2Cxx0000001234AAA added.add(addPlan1); // Assign added plans input.addedPlans = added; // 3) Plans to DELETE (provide existing Group Census Member Plan record Ids) input.deletedPlans = new List{ // 'REPLACE\_WITH\_MEMBER\_PLAN\_ID\_1', // 'REPLACE\_WITH\_MEMBER\_PLAN\_ID\_2' }; // 4) Execute the PATCH API with the Group Census Member Id String memberId = '0r6xx00000004LGAAY'; try { ConnectApi.InsuranceUpdateMemberPlansOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.patchInsuranceUpdateMemberPlans(input, memberId); System.debug('Update Member Plans result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error while updating member plans: ' + e.getMessage()); } # patchInsuranceUpdateMembers(censusMgmtInputParam, groupCensusId) Update group census members. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceCensusMgmtOutputRepresentation patchInsuranceUpdateMembers(ConnectApi.InsuranceCensusMgmtInputRepresentation censusMgmtInputParam, String groupCensusId) ## Parameters **censusMgmtInputParam** - Type: [ConnectApi.InsuranceCensusMgmtInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_mgmt.htm "Input representation for adding or updating census members.") - Details to update the census members. **groupCensusId** - Type: String - ID of the group census. ## Return Value Type: [ConnectApi.InsuranceCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_mgmt.htm "Output representation for the insurance census management process.") # Pay Claim Coverage Payment Detail Output representation for paying a claim coverage payment detail. ## JSON Example { "claimPaymentSummaryId": "0sDxx0000000001CAA", "consumedLimitCount": 5, "errors": \[\], "hasFinancialAuthority": true, "insPolicyLimitTrackingIds": \[ "0qOxx0000004CvQEAU", "0qOxx0000004CvREAU" \], "isFinancialAuthorityConfigured": true, "isSuccess": true, "paidAmount": 5000.00, "remainingReserves": \[ { "remainingReserveAmount": 2500.00, "reserveLimitRecordId": null, "scope": "ClaimCoverage" }, { "remainingReserveAmount": 8000.00, "reserveLimitRecordId": null, "scope": "Claim" } \], "warnings": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | claimPayment​SummaryId | String | ID of the claim payment summary record that's added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim. | Small, 66.0 | 66.0 | | consumedLimit​Count | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | Small, 66.0 | 66.0 | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Details of the errors that are associated with the API operation. | Big, 65.0 | 65.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). This property is returned when shouldCheckFinancialAuthority is true and the claim coverage payment detail is in Draft status. | Big, 68.0 | 68.0 | | insPolicyLimit​TrackingIds | String\[\] | IDs of the insurance policy limit tracking records that are created during the payment process. | Small, 66.0 | 66.0 | | isFinancialAuthority​Configured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). This property is returned when shouldCheckFinancialAuthority is true and the claim coverage payment detail is in Draft status. | Big, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Big, 65.0 | 65.0 | | paidAmount | Double | Total amount that's paid. | Small, 66.0 | 66.0 | | remainingReserves | [Remaining Reserve](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_remaining_reserve.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\[\] | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | Small, 68.0 | 68.0 | | warnings | String\[\] | List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | Small, 68.0 | 68.0 | # Pay Claim Coverage Payment Detail (POST) Process the payment for a claim coverage payment detail record. ## Resource {claimId}, {coverageId}, and {paymentDetailId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/pay ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/pay ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim under which the payment is made. | Required | 65.0 | | coverageId | String | ID of the claim coverage record that the payment detail is associated with. | Required | 65.0 | | paymentDetailId | String | ID of the claim coverage payment detail record that you want to pay. | Required | 65.0 | ## Request Body for POST ### JSON Example { "options": { "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [Pay Claim Coverage Payment Detail Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_options_input.htm "Input representation of the options to control which pre-payment check to run for a claim coverage payment detail.") | Optional toggles to control the pre-payment checks. | Optional | 68.0 | ## Response Body for POST [Pay Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_pay_claim_coverage_payment_detail.htm "Output representation for paying a claim coverage payment detail.") # Pay Claim Coverage Payment Detail Action Initiate the payment for a claim coverage payment detail record, track the policy limit consumption for the payout, and update the status of the claim coverage payment detail record to Paid. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/payClaimCvrPaymentDetail Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | payClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex [ConnectApi.PayClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_cvr_pymt_dtl_input_re.htm "Input representation for the Pay Claim Coverage Payment Detail action.") record that contains the details of the claim coverage payment detail to be paid. | ## Outputs | Output | Type | Description | | --- | --- | --- | | payClaimCvrPymtDtlOutputRep | Apex-defined | An Apex [ConnectApi.PayClaimCvrPymtDtlOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_claim_cvr_pymt_dtl_output_re.htm "Output representation for the Pay Claim Coverage Payment Detail action.") record that contains the details of the payment status. | ## Example Sample Request { "inputs": \[ { "payClaimCvrPymtDtlInputRep": { "claimId": "0Zkxx000000001dEAA", "coverageId": "0kPxx000000002fEAA", "paymentDetailId": "5pdS70000004oVfIAI", "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true } } \] } Sample Response \[ { "actionName": "payClaimCvrPaymentDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "payClaimCvrPymtDtlOutputRep": { "isSuccess": true, "hasFinancialAuthority": true, "isFinancialAuthorityConfigured": true, "remainingReserves": \[ { "remainingReserveAmount": 2500.00, "reserveLimitRecordId": null, "scope": "ClaimCoverage" } \], "warnings": \[\] } }, "sortOrder": -1, "version": 1 } \] # Pay Claim Coverage Payment Detail Input Input representation for paying a claim coverage payment detail. ## JSON Example { "options": { "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [Pay Claim Coverage Payment Detail Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_options_input.htm "Input representation of the options to control which pre-payment check to run for a claim coverage payment detail.") | Optional toggles to control the pre-payment checks. | Optional | 68.0 | # Pay Claim Coverage Payment Detail Options Input Input representation of the options to control which pre-payment check to run for a claim coverage payment detail. ## JSON Example { "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true } ## Properties
Name Type Description Required or Optional Available Version
shouldCheckFinancial​Authority Boolean Indicates whether to run the User Financial Authority (UFA) check before payment (true) or not (false). The default value is false. Applies to a claim coverage payment detail in Draft status.

If set to true and the claim coverage payment detail is in Draft status, the response includes hasFinancialAuthority and isFinancialAuthorityConfigured.

If set to true, and the user doesn’t have sufficient authority, this API routes the claim coverage payment detail to PendingAuthority for approval.

 Optional 68.0
shouldVerifyReserve​Limit Boolean Indicates whether to run the reserve-limit check before payment (true) or not (false). The default value is false.

If set to true, the response includes remainingReserves. If the payment exceeds a reserve, the response also includes warnings that describe which reserves were exceeded and by how much. The payment is still processed successfully. This behavior applies to the Pay Claim Coverage Payment Detail and Pay Ex Gratia Claim Coverage Payment Detail resources.

 Optional 68.0
# Pay Ex Gratia Claim Coverage Payment Detail Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail. ## JSON Example { "claimPaymentSummaryId": "0sDxx0000000001CAA", "consumedLimitCount": 5, "errors": \[\], "exceededAmount": 1500.00, "exceededCount": 2, "hasFinancialAuthority": true, "insPolicyLimitTrackingIds": \[ "0qOxx0000004CvQEAU", "0qOxx0000004CvREAU" \], "isFinancialAuthorityConfigured": true, "isSuccess": true, "paidAmount": 5000.00, "remainingReserves": \[ { "remainingReserveAmount": 2500.00, "reserveLimitRecordId": null, "scope": "ClaimCoverage" }, { "remainingReserveAmount": 8000.00, "reserveLimitRecordId": null, "scope": "Claim" } \], "warnings": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | claimPayment​SummaryId | String | ID of the claim payment summary record that’s added or updated. This ID links individual claim coverage payment details to the corresponding summary of payments that are processed for a claim. | Small, 66.0 | 66.0 | | consumedLimit​Count | Integer | Total number of coverage units or limit counts that are utilized by this service or transaction. | Small, 66.0 | 66.0 | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Error details that are shown when the API operation fails. | Small, 66.0 | 66.0 | | exceededAmount | Double | Excess amount that’s paid above the limits. | Small, 66.0 | 66.0 | | exceededCount | Integer | Number of coverage units or counts that are paid above the policy limits. This occurs when payments exceed the allowable limits, such as in discretionary ex gratia payments. | Small, 66.0 | 66.0 | | hasFinancialAuthority | Boolean | Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). This property is returned when shouldCheckFinancialAuthority is true and the claim coverage payment detail is in Draft status. | Big, 68.0 | 68.0 | | insPolicyLimit​TrackingIds | String\[\] | IDs of the insurance policy limit tracking records that are created during the ex gratia payment process. | Small, 66.0 | 66.0 | | isFinancialAuthority​Configured | Boolean | Indicates whether a User Financial Authority (UFA) record is configured for the current user (true) or not (false). This property is returned when shouldCheckFinancialAuthority is true and the claim coverage payment detail is in Draft status. | Big, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the API operation is successful (true) or not (false). | Small, 66.0 | 66.0 | | paidAmount | Double | Total amount that’s paid towards ex gratia. | Small, 66.0 | 66.0 | | remainingReserves | [Remaining Reserve](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_remaining_reserve.htm "Output representation for the remaining reserve amount and scope after the payment is processed.")\[\] | List of remaining reserves, including the remaining amount and scope of each reserve after the payment is processed. | Small, 68.0 | 68.0 | | warnings | String\[\] | List of warning messages that are generated when the payment exceeds reserve limits, indicating which reserves are exceeded and by how much. The payment is still processed successfully. | Small, 68.0 | 68.0 | # Pay Ex Gratia Claim Coverage Payment Detail (POST) Process a discretionary ex gratia payment for a claim coverage payment detail, enabling payment even when coverage or policy limits are exceeded. Use this resource to pay the full adjusted amount for a loss type payment detail, regardless of whether policy limits are reached. The system records limit consumption only up to the remaining available limit and tracks the excess as an ex gratia amount. ## Resource {claimId}, {coverageId}, and {paymentDetailId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/pay-ex-gratia ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/payment-details/0l2xx000000003gEAA/pay-ex-gratia ## Available Version 66.0 ## HTTP Methods POST ## Path Parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim. | Required | 66.0 | | coverageId | String | ID of the coverage that applies to the claim. | Required | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail record. | Required | 66.0 | ## Request Body for POST ### JSON Example { "options": { "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true }, "reason": "Customer goodwill gesture despite exceeded limits." } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [Pay Claim Coverage Payment Detail Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_options_input.htm "Input representation of the options to control which pre-payment check to run for a claim coverage payment detail.") | Option to control the pre-payment checks. | Optional | 68.0 | | reason | String | Reason for the ex gratia payment. Maximum character length is 255. | Optional | 66.0 | ## Response Body for POST [Pay Ex Gratia Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_pay_ex_gratia_claim_cvr_payment_detail.htm "Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail.") # Pay Ex Gratia Claim Coverage Payment Detail Action Process ex gratia payments for the claim coverage payment detail record when the adjusted amount is greater than the policy limit amount or count or both. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/payExGratiaClaimCvrPymtDetail Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | payExGratiaClaimCvrPymtDtlInputRep | Apex-defined | Required. An Apex [ConnectApi.PayExGratiaClaimCvrPymtDtlInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_ex_gratia_claim_cvr_pymt_dtl_input_re.htm "Input representation for the Pay Ex Gratia Claim Coverage Payment Detail action.") record that contains the details to process the ex gratia payment. | ## Outputs | Output | Type | Description | | --- | --- | --- | | payExGratiaClaimCvrPymtDtlRep | Apex-defined | An Apex [ConnectApi.PayExGratiaClaimCvrPymtDtlRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_ex_gratia_claim_cvr_pymt_dtl_rep.htm "Output representation for the Pay Ex Gratia Claim Coverage Payment Detail action.") record that contains the ex gratia payment details. | ## Example **POST** This sample request is for the Pay Ex Gratia Claim Coverage Payment Detail action. { "inputs": \[ { "payExGratiaClaimCvrPymtDtlInputRep": { "claimId": "0Zkxx0000000001CAA", "coverageId": "0kPxx0000000001CAA", "paymentDetailId": "0k5xx0000000001AAA", "reason": "Ex gratia payment approved for customer satisfaction.", "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true } } \] } This sample response is for the Pay Ex Gratia Claim Coverage Payment Detail action. \[ { "actionName": "payExGratiaClaimCvrPymtDetail", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "payExGratiaClaimCvrPymtDtlRep": { "claimPaymentSummaryId": "0sDxx0000000001CAA", "consumedLimitCount": 5, "exceededAmount": 1500, "exceededCount": 2, "hasFinancialAuthority": true, "insPolicyLimitTrackingIds": \[ "0qOxx0000004CvQEAU", "0qOxx0000004CvREAU" \], "isFinancialAuthorityConfigured": true, "isSuccess": true, "paidAmount": 5000, "remainingReserves": \[ { "remainingReserveAmount": 2500.00, "reserveLimitRecordId": null, "scope": "ClaimCoverage" } \], "warnings": \[\] } }, "sortOrder": -1, "version": 1 } \] # Pay Ex Gratia Claim Coverage Payment Detail Input Input representation for the ex gratia payment for the claim coverage payment detail. ## JSON Example { "options": { "shouldCheckFinancialAuthority": true, "shouldVerifyReserveLimit": true }, "reason": "Customer goodwill gesture despite exceeded limits." } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | options | [Pay Claim Coverage Payment Detail Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_options_input.htm "Input representation of the options to control which pre-payment check to run for a claim coverage payment detail.") | Option to control the pre-payment checks. | Optional | 68.0 | | reason | String | Reason for the ex gratia payment. Maximum character length is 255. | Optional | 66.0 | # PayClaimCoveragePaymentDetail(claimId, coverageId, paymentDetailId, PayClaimCoveragePaymentDetailInput) Process payment for a specific claim coverage payment detail record. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.PayClaimCoveragePaymentDetailRep PayClaimCoveragePaymentDetail(String claimId, String coverageId, String paymentDetailId, ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation PayClaimCoveragePaymentDetailInput) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage. **paymentDetailId** - Type: String - ID of the claim coverage payment detail to process. **PayClaimCoveragePaymentDetailInput** - Type: [ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_claim_coverage_payment_detail.htm "Input representation for paying a claim coverage payment detail.") - Optional toggles that control which pre-payment checks run. ## Return Value Type: [ConnectApi.PayClaimCoveragePaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_claim_coverage_payment_detail.htm "Output representation for a claim coverage payment detail operation.") ## Example Use the PayClaimCoveragePaymentDetailCallable Apex class to trigger payment for a claim coverage payment detail record in an insurance claim. This class serves as an Apex wrapper for the Connect API endpoint: /connect/insurance/claims/{claimId}/coverages/{coverageId}/payment-details/{paymentDetailId}/pay. You can use this method to automate payment operations directly from Apex. **Class Definition** public with sharing class PayClaimCoveragePaymentDetailCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'payClaimCoveragePaymentDetail') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); String claimCoveragePaymentDetailId = (String) inputMap.get('claimCoveragePaymentDetailId'); System.debug('Start of connect API call to pay claim coverage payment detail'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); System.debug('Claim Coverage Payment Detail ID: ' + claimCoveragePaymentDetailId); // Initialize the input representation and optional pre-payment checks ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation payInput = new ConnectApi.PayClaimCoveragePaymentDetailInputRepresentation(); payInput.options = new ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep(); payInput.options.shouldCheckFinancialAuthority = true; payInput.options.shouldVerifyReserveLimit = true; // Initialize the output representation ConnectApi.PayClaimCoveragePaymentDetailRep paymentDetailData; // Call the Connect API to pay claim coverage payment detail try { // Call the Connect API resource directly using the correct method signature // The endpoint is: /connect/insurance/claims/${claimId}/coverages/${coverageId}/payment-details/${paymentDetailId}/pay paymentDetailData = ConnectApi.InsuranceClaimFamily.payClaimCoveragePaymentDetail( claimId, claimCoverageId, claimCoveragePaymentDetailId, payInput ); System.debug('Claim coverage payment detail paid successfully: ' + paymentDetailData); // Put the payment detail data in the output map outputMap.put('paymentDetailData', paymentDetailData); outputMap.put('isPaid', paymentDetailData.isSuccess); // Check if there are any errors if (paymentDetailData.errors != null && !paymentDetailData.errors.isEmpty()) { outputMap.put('errors', paymentDetailData.errors); System.debug('Errors found: ' + paymentDetailData.errors); } } catch (Exception e) { System.debug('Error while paying claim coverage payment detail: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isPaid', false); } // Return the payment detail data return paymentDetailData; } // If the action is not recognized, return null return null; } } // Usage Example: PayClaimCoveragePaymentDetailCallable callable = new PayClaimCoveragePaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0Zkxx000000002ZCAQ'); // Claim ID input.put('claimCoverageId', '0kPxx000000000cEAA'); // Claim Coverage ID input.put('claimCoveragePaymentDetailId', '0l2xx000000002cAAA'); // Claim Coverage Payment Detail ID // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'payClaimCoveragePaymentDetail' action Object result = callable.call('payClaimCoveragePaymentDetail', args); // Check the result if (result != null) { System.debug('Claim coverage payment detail processed successfully: ' + result); // Access the processed payment detail data ConnectApi.PayClaimCoveragePaymentDetailRep paymentDetailData = (ConnectApi.PayClaimCoveragePaymentDetailRep) result; // Process the result as needed System.debug('Payment Detail Data: ' + paymentDetailData); // Check if the payment was successful if (paymentDetailData.isSuccess) { System.debug('Payment was successful'); } else { System.debug('Payment failed'); if (paymentDetailData.errors != null) { System.debug('Error details: ' + paymentDetailData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } **Usage Example** PayClaimCoveragePaymentDetailCallable callable = new PayClaimCoveragePaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0Zkxx000000002ZCAQ'); // Claim ID input.put('claimCoverageId', '0kPxx000000000cEAA'); // Claim Coverage ID input.put('claimCoveragePaymentDetailId', '0l2xx000000002cAAA'); // Claim Coverage Payment Detail ID // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'payClaimCoveragePaymentDetail' action Object result = callable.call('payClaimCoveragePaymentDetail', args); // Check the result if (result != null) { System.debug('Claim coverage payment detail processed successfully: ' + result); // Access the processed payment detail data ConnectApi.PayClaimCoveragePaymentDetailRep paymentDetailData = (ConnectApi.PayClaimCoveragePaymentDetailRep) result; // Process the result as needed System.debug('Payment Detail Data: ' + paymentDetailData); // Check if the payment was successful if (paymentDetailData.isSuccess) { System.debug('Payment was successful'); } else { System.debug('Payment failed'); if (paymentDetailData.errors != null) { System.debug('Error details: ' + paymentDetailData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # PayExGratiaClaimCvrPaymentDetail(claimId, coverageId, paymentDetailId, PayExGratiaClaimCvrPaymentDetailInput) Process an ex gratia payment for a claim coverage payment detail record. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.PayExGratiaClaimCvrPaymentDetailRep PayExGratiaClaimCvrPaymentDetail(String claimId, String coverageId, String paymentDetailId, ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep PayExGratiaClaimCvrPaymentDetailInput) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the coverage. **paymentDetailId** - Type: String - ID of the payment detail. **PayExGratiaClaimCvrPaymentDetailInput** - Type: [ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_pay_ex_gratia_claim_cvr_payment_detail.htm "Input representation for the ex gratia payment for the claim coverage payment detail.") - Details to process the ex gratia payment. ## Return Value Type: [ConnectApi.PayExGratiaClaimCvrPaymentDetailRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_pay_ex_gratia_claim_cvr_payment_detail.htm "Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail.") ## Example **Class Definition** This is a sample Apex code to define the PayExGratiaClaimCvrPaymentDetail class to process ex gratia payment. public with sharing class PayExGratiaClaimCvrPaymentDetailCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'payExGratiaClaimCvrPaymentDetail') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); String paymentDetailId = (String) inputMap.get('paymentDetailId'); ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep payExGratiaInputRep = (ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep) inputMap.get('PayExGratiaClaimCvrPaymentDetailInput'); if (payExGratiaInputRep == null) { payExGratiaInputRep = new ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep(); } payExGratiaInputRep.options = new ConnectApi.PayClaimCoveragePaymentDetailOptionsInputRep(); payExGratiaInputRep.options.shouldCheckFinancialAuthority = true; payExGratiaInputRep.options.shouldVerifyReserveLimit = true; System.debug('Start of connect API call to pay ex gratia claim coverage payment detail'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); System.debug('Payment Detail ID: ' + paymentDetailId); // Initialize the output representation ConnectApi.PayExGratiaClaimCvrPaymentDetailRep payExGratiaResponse; // Call the Connect API to pay ex gratia try { // Call the Connect API resource directly // The endpoint is: /connect/insurance/claims/${claimId}/coverages/${coverageId}/payment-details/${paymentDetailId}/pay-ex-gratia payExGratiaResponse = ConnectApi.InsuranceClaimFamily.PayExGratiaClaimCvrPaymentDetail( payExGratiaInputRep, claimId, claimCoverageId, paymentDetailId ); System.debug('Pay ex gratia completed successfully: ' + payExGratiaResponse); // Put the payExGratiaResponse in the output map outputMap.put('payExGratiaResponse', payExGratiaResponse); outputMap.put('isSuccess', payExGratiaResponse.isSuccess); // Check if there are any errors if (payExGratiaResponse.errors != null && !payExGratiaResponse.errors.isEmpty()) { outputMap.put('errors', payExGratiaResponse.errors); System.debug('Errors found: ' + payExGratiaResponse.errors); } } catch (Exception e) { System.debug('Error while paying ex gratia: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isSuccess', false); } return payExGratiaResponse; } // If the action is not recognized, return null return null; } } **Usage Example** This example shows how to call the PayExGratiaClaimCvrPaymentDetail class and include the required input data. PayExGratiaClaimCvrPaymentDetailCallable callable = new PayExGratiaClaimCvrPaymentDetailCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0ZkSB0000001AVH0A2'); // Claim ID input.put('claimCoverageId', '0kPSB000000GHdu2AG'); // Claim Coverage ID input.put('paymentDetailId', '0l2SB000000CLsMYAW'); // Payment Detail ID // Create the input representation object // First create a Map with the properties Map payExGratiaInputMap = new Map(); payExGratiaInputMap.put('reason', 'Customer service goodwill payment'); Map optionsMap = new Map(); optionsMap.put('shouldCheckFinancialAuthority', true); optionsMap.put('shouldVerifyReserveLimit', true); payExGratiaInputMap.put('options', optionsMap); // Convert the Map to ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep using JSON.deserialize String jsonString = JSON.serialize(payExGratiaInputMap); ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep payExGratiaInputRep = (ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep) JSON.deserialize(jsonString, ConnectApi.PayExGratiaClaimCvrPaymentDetailInputRep.class); input.put('PayExGratiaClaimCvrPaymentDetailInput', payExGratiaInputRep); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'payExGratiaClaimCvrPaymentDetail' action Object result = callable.call('payExGratiaClaimCvrPaymentDetail', args); // Check the result if (result != null) { System.debug('payExGratiaClaimCvrPaymentDetail processed successfully: ' + result); // Access the processed payment data ConnectApi.PayExGratiaClaimCvrPaymentDetailRep paymentData = (ConnectApi.PayExGratiaClaimCvrPaymentDetailRep) result; // Process the result as needed System.debug('Pay Ex Gratia Payment Data: ' + paymentData); // Check if the payment was successful if (paymentData.isSuccess) { System.debug('Pay Ex Gratia was successful'); System.debug('Paid Amount: ' + paymentData.paidAmount); System.debug('Remaining Reserves: ' + paymentData.remainingReserves); System.debug('Claim Payment Summary ID: ' + paymentData.claimPaymentSummaryId); System.debug('Consumed Limit Count: ' + paymentData.consumedLimitCount); System.debug('Exceeded Amount: ' + paymentData.exceededAmount); System.debug('Exceeded Count: ' + paymentData.exceededCount); System.debug('Has Financial Authority: ' + paymentData.hasFinancialAuthority); System.debug('Is Financial Authority Configured: ' + paymentData.isFinancialAuthorityConfigured); if (paymentData.warnings != null && !paymentData.warnings.isEmpty()) { System.debug('Warnings: ' + paymentData.warnings); } if (paymentData.insPolicyLimitTrackingIds != null && !paymentData.insPolicyLimitTrackingIds.isEmpty()) { System.debug('Insurance Policy Limit Tracking IDs: ' + paymentData.insPolicyLimitTrackingIds); } } else { System.debug('Pay Ex Gratia failed'); if (paymentData.errors != null) { System.debug('Error details: ' + paymentData.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # Plan Benefit Attribute Input Represents details of the plan benefits attributes for an Insurance Policy Coverage. ## JSON Example { "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 400 }, { "attributeDefinitionId": "0tjSG00000020yPxxQ", "name": "Deductible waiver", "value": "Deductible waived" } \] } ## Properties | Name | Type | Description | | Required or Optional | Available Version | | --- | --- | --- | --- | --- | --- | | attributeDefinitionId | String | ID of the Attribute Definition. | | Required | 63.0 | | name | String | Name of the attribute. | | Optional | 63.0 | | value | String | Value of the attribute. | | Required | 63.0 | # Plan Benefit Input Represents details of the plan benefits for an Insurance Policy Coverage. ## JSON Example { "networks": \[ { "network": "First Network Tier", "name": "Preferred Network" }, { "network": "Second Network Tier", "name": "In Network" } \], "benefits": \[ { "productId": "01tSG0000011yBFxxY", "productCompGgpId": "0y7SG0000000ZiXxxU", "productName": "Chiropractic Care", "network": "First Network Tier", "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 311 }, { "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Deductible", "value": "100" } \] } \] } | Name | Type | Descriptions | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Benefit Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_attribute_input.htm "Represents details of the plan benefits attributes for an Insurance Policy Coverage.") | List of benefit attributes. | Optional | 63.0 | | network | String | The tier type of the network. | Optional | 63.0 | | networks | [Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | Insurance Policy Coverage Networks for creating plan benefits. | Required | 63.0 | | productCompGgpId | String | ID of product component group. | Optional | 63.0 | | productId | String | ID of the product. | Required | 63.0 | | productName | String | Name of the product. | Optional | 63.0 | ## Properties | Name | Type | Descriptions | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Benefit Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_attribute_input.htm "Represents details of the plan benefits attributes for an Insurance Policy Coverage.") | List of benefit attributes. | Optional | 63.0 | | network | String | The tier type of the network. | Optional | 63.0 | | networks | [Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | Insurance Policy Coverage Networks for creating plan benefits. | Required | 63.0 | | productCompGgpId | String | ID of product component group. | Optional | 63.0 | | productId | String | ID of the product. | Required | 63.0 | | productName | String | Name of the product. | Optional | 63.0 | # Plan Benefit Networks Output representation details of the insurance policy coverage networks. ## JSON Example { "networks": \[ { "id": "n1", "network": "FIRST\_NETWORK\_TIER", "name": "Preferred Network", "sequence": 1 }, { "id": "n2", "network": "SECOND\_NETWORK\_TIER", "name": "In Network", "sequence": 2 } \] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | id | String | ID of the insurance policy coverage network. | 63.0 | | name | String | Name of the insurance policy coverage network. | 63.0 | | network | String | Insurance policy coverage network tier type. | 63.0 | | sequence | String | Sequence field of the insurance policy coverage network. | 63.0 | # Plan Benefit Update Input Represents details of the plan benefits for an Insurance Policy Coverage. ## JSON Example { "benefits": \[ { "benefitId": "1HSSG0000005Ws7xxE", "productId": "01tSG0000011yBFxxY", "productCompGgpId": "0y7SG0000000ZiXxxU", "productName": "Chiropractic Care", "attributes": \[ { "covBnftAttrId": "1HYSG00000002GPxxY", "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 311 }, { "covBnftAttrId": "1HYSG00000002GQxxY", "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Notes", "value": "Preferred network limitations apply." } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefitId | String | ID of the Insurance Policy Coverage Benefit. | Required | 63.0 | | productId | String | ID of the product. | Optional | 63.0 | | productCompGgpId | String | ID of product component group | Optional | 63.0 | | productName | String | Name of the product. | Optional | 63.0 | | network | String | The tier type of the network. | Optional | 63.0 | | attributes | String | List of attributes. | Optional | 63.0 | | covBnftAttrId | String | ID of Insurance Policy Coverage Benefit Attribute. | Required | 63.0 | | name | String | Name of the attribute. | Optional | 63.0 | | value | String | Value of the attribute. | Optional | 63.0 | | attributeDefinitionId | String | ID of the Attribute Definition. | Optional | 63.0 | # Plan Benefits Output representation details of the create and update plan benefits request. ## JSON Example { "isSuccess":true, "errors":\[\] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | isSuccess | Boolean | Indicates whether the request is successful(true)or not(false). | 63.0 | | errors | String | The details of any errors. | 63.0 | # Plan Benefits (GET, POST, PATCH, DELETE) Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage. ## Resource {coverageId} is a placeholder. /connect/insurance/brokerage/coverages/{coverageId}/benefits ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/coverages/0kPxx000000002fEAA/benefits ## Available Version 63.0 ## HTTP Methods GET, POST, PATCH, DELETE ## Response Body for GET [Plan Benefits Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_plan_benefits.htm "Output representation details of the insurance policy benefits.") ## Request Body for POST ### JSON Example { "networks": \[ { "network": "First Network Tier", "name": "Preferred Network" }, { "network": "Second Network Tier", "name": "In Network" } \], "benefits": \[ { "productId": "01tSG0000011yBFxxY", "productCompGgpId": "0y7SG0000000ZiXxxU", "productName": "Chiropractic Care", "network": "First Network Tier", "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 311 }, { "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Deductible", "value": "100" } \] } \] } ### Properties | Name | Type | Descriptions | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributes | [Benefit Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_attribute_input.htm "Represents details of the plan benefits attributes for an Insurance Policy Coverage.") | List of benefit attributes. | Optional | 63.0 | | network | String | The tier type of the network. | Optional | 63.0 | | networks | [Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | Insurance Policy Coverage Networks for creating plan benefits. | Required | 63.0 | | productCompGgpId | String | ID of product component group. | Optional | 63.0 | | productId | String | ID of the product. | Required | 63.0 | | productName | String | Name of the product. | Optional | 63.0 | ## Response Body for POST [Plan Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_plan_benefit_output.htm "Output representation details of the create and update plan benefits request.") ## Request Body for PATCH ### JSON Example { "networks": \[ { "networkId": "1HXSG0000002xxxxAM", "name": "Preferred Network Updated" }, { "networkId": "1HXSG0000002xxxxA2", "name": "In Network Updated" }, { "network": "Third Network Tier", "name": "Out Network" } \], "benefits": \[ { "benefitId": "1HSSG0000005Ws7xxE", "productId": "01tSG0000011yBFxxY", "productCompGgpId": "0y7SG0000000ZiXxxU", "productName": "Chiropractic Care", "attributes": \[ { "covBnftAttrId": "1HYSG00000002GPxxY", "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 311 }, { "covBnftAttrId": "1HYSG00000002GQxxY", "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Notes", "value": "Preferred network limitations apply." } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefits | [Benefits Input \[\]](connect_requests_plan_benefit_update_input.htm "Represents details of the plan benefits for an Insurance Policy Coverage.") | The benefits of the Insurance Plan Coverage. | Optional | 63.0 | | networks | [Networks Input \[\]](connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | The list of networks. | Optional | 63.0 | ## Response Body for PATCH [Plan Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_plan_benefit_output.htm "Output representation details of the create and update plan benefits request.") ## Request Parameters for DELETE | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefitIds | String\[\] | IDs of Insurance Policy Coverage Benefit. If benefitIds are provided, the service will only delete the respective Insurance Policy Coverage Benefit records. | Optional | 63.0 | | networkIds | String\[\] | IDs of the Insurance Policy Coverage Network. IfnetworkIds are provided, the service will only delete the respective Insurance Policy Coverage Network records and their associated Insurance Policy Coverage Benefit records. | Optional | 63.0 | # Plan Benefits Attribute Represents details of the plan benefits attributes for an Insurance Policy Coverage. ## JSON Example { "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 400, "sequence": 1, "keyHidden": false, "dataType": "Currency" }, { "attributeDefinitionId": "0tjSG00000020yPxxQ", "name": "Deductible waiver", "value": "Deductible waived", "sequence": 2, "keyHidden": true, "dataType": "Text" } \] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributeDefinitionId | String | ID of the Attribute Definition. | 63.0 | | name | String | Name of the attribute. | 63.0 | | value | String | Value of the attribute. | 63.0 | | sequence | Integer | Sequence field of the product classification attribute or product attribute definition. | 63.0 | | keyHidden | Boolean | IsHidden field of the Product classification attribute or Product attribute definition. | 63.0 | | dataType | String | Data type of the Attribute Definition. | 63.0 | # Plan Benefits Attributes Output representation details of the benefits attributes for an insurance policy coverage plan. ## JSON Example { "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 400, "sequence": 1, "keyHidden": false, "dataType": "Currency" }, { "attributeDefinitionId": "0tjSG00000020yPxxQ", "name": "Deductible waiver", "value": "Deductible waived", "sequence": 2, "keyHidden": true, "dataType": "Text" }, { "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Notes", "value": "In network limitations apply.", "sequence": 2, "keyHidden": true, "dataType": "Text" } \] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributeDefinitionId | String | Indicates whether the request is successful(true)or not(false). | 63.0 | | dataType | String | Datatype of the Attribute Definition. | 63.0 | | keyHidden | String | IsHidden field of the Product classification attribute or Product attribute definition. | 63.0 | | name | String | Type of tier of the network. | 63.0 | | sequence | String | Sequence field of the Product classification attribute or Product attribute definition. | 63.0 | | value | String | ID of the product. | 63.0 | # Plan Benefits Details Output representation details of the insurance policy benefits. ## JSON Example { "isSuccess": true, "errors": \[\], "networks": \[ { "id": "n1", "network": "FIRST\_NETWORK\_TIER", "name": "Preferred Network", "sequence": 1 }, { "id": "n2", "network": "SECOND\_NETWORK\_TIER", "name": "In Network", "sequence": 2 } \], "benefits": \[ { "benefitId": "bft1", "benefitSequence": 1, "productId": "01tSG0000011yBFYAY", "productName": "Preventive Care", "productCompGrpId": "0y7SG0000000Q8zYAE", "productCompGgpName": "General plan information", "productCompGgpSequence": 1, "network": "First Network Tier", "attributes": \[ { "attributeDefinitionId": "0tjSG0000001embYAA", "name": "Copay", "value": 400, "sequence": 1, "keyHidden": false, "dataType": "Currency" }, { "attributeDefinitionId": "0tjSG00000020yPYAQ", "name": "Deductible waiver", "value": "Deductible waived", "sequence": 2, "keyHidden": true, "dataType": "Text" }, { "attributeDefinitionId": "0tjSG0000001YmMYAU", "name": "Notes", "value": "In network limitations apply.", "sequence": 2, "keyHidden": true, "dataType": "Text" } \], "combinedValue": "Copay $400 | Deductible waived | In network limitations apply." } \] } ## Properties | Name | Type | Description | Available Version | | --- | --- | --- | --- | | attributes | [Benefit Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_create_attributes.htm "Represents details of the plan benefits attributes for an Insurance Policy Coverage.") | List of attributes. | 63.0 | | benefits | [Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_benefits_output.htm "Output representation details of the plan benefits for an insurance policy coverage plan.") | Details of the plan benefit. | 63.0 | | combinedValue | String | Combined value of the Insurance Policy Coverage Benefit Attribute for a benefit. | 63.0 | | errors | List | List of errors. | 63.0 | | isSuccess | Boolean | Boolean to determine whether it was success or failure. | 63.0 | | network | String | The tier type of the network. | 63.0 | | networks | [Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_network_input.htm "Output representation details of the insurance policy coverage networks.") | Insurance Policy Coverage Networks for creating plan benefits. | 63.0 | | productCompGgpId | String | ID of product component group | 63.0 | | productId | String | ID of the product. | 63.0 | | productName | String | Name of the product. | 63.0 | # Plan Benefits Product Model (GET) Get the product model details along with child components and their attributes for a given insurance policy coverage. ![Note](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/images/icon_note.png) #### Note See [Prerequisites](https://help.salesforce.com/s/articleView?id=ind.insurance_brokerage_product_modelling_prerequisites.htm&type=5&language=en_US) to define the product model structure. If this model isn't followed, the API throws an error. ## Resource {coverageId} is a placeholder. /connect/insurance/brokerage/coverages/{coverageId}/benefits/product ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/coverages/0kPxx000000002fEAA/benefits/product ## Available Version 63.0 ## HTTP Methods GET ## Path Parameter for GET
Name Type Description Required or Optional Available Version
coverageId String

ID of insurance policy coverage.

Required 63.0
## Response Body for GET [Plan Benefits Product Model](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_plan_benefits_product_model_output.htm "Output representation of the product model details and associated product components.") # Plan Benefits Product Model Details Output representation of the product model details and associated product components. ## JSON Example This example shows a sample success response. { "isSuccess":true, "errors":\[\], "productId": "01tSG0000013itZYAQ", "benefits": \[ { "id": "01tSG0000011y9dYAA", "name": "Annual deductible/Individual", "componentGroupId": "0y7SG0000000Q8zYAE", "componentGroupName": "General plan information", "componentGroupSequence": 1, #optional "sequence": 1, #optional "attributes": \[ { "id": "0tjSG0000001embYAA", "sequence": 1, #optional "name": "Copay", "label": "Copay Currency", #optional "dataType": "CURRENCY", "keyHidden":false, "isActive": true }, { "id": "0tjSG0000001eoDYAQ", "sequence": 1, "name": "Coinsurance", "label": "Coinsurance Percentage", "dataType": "PERCENTAGE", "keyHidden":false, "isActive": true } \] } \] } This request shows a sample error response. { "isSuccess":false, "errors" : \[ { "code":INVALID\_INPUT, "message": "Specify a valid coverageId." } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | benefits | [Product](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product.htm "Output representation of product details.")\[\] | List of the product component groups and associated attributes. | Small, 63.0 | 63.0 | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | List of errors during the processing of the API request. | Small, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 63.0 | 63.0 | | productId | String | ID of the product for which the benefits are fetched. | Small, 63.0 | 63.0 | # Policy Output representation of policy details. ## JSON Example This request shows a sample success response. { "policyId": "0YTxx0000000253GAA" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_output.htm "Output representation of the error details.") | List of errors that occurred during the processing of the API request. | Small, 63.0 | 63.0 | | originalPolicyId | String | ID of the original policy. | Small, 63.0 | 63.0 | | policyId | String | ID of the issued or endorsed policy. | Small, 63.0 | 63.0 | # Policy Lifecycle Management Enroll members, apply mid-term adjustments, and renew member policies. - **[Process Member Enrollment Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_process_member_enrollment.htm)** Create insurance policies for specified group census members as per their selected plans. - **[Renew Group Census Member Policies Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_process_member_renewal.htm)** Renew group census member policies for contract renewal. This action creates renewed insurance policies, and links the newly created policies to the previous policies. - **[Process Member Plans for Mid-Term Adjustment Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_process_mid_term_adjustment_member_plans.htm)** Apply mid-term adjustment changes for group insurance policies to group census member plans. - **[Apply Contract Adjustment to Member Policy Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_process_contract_mta_member_policy.htm)** Apply contract adjustment to group insurance policy for a primary group census member and a contract group plan. For each plan, the action enrolls a new policy, endorses an existing policy, or cancels a policy for a removed plan based on the endorsed contract version and the member's plan configuration. # Policy Lifecycle Management Enroll members, apply mid-term adjustments, and renew member policies. - **[Group Enrollment (POST)](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. - **[Policy Renewals (POST)](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. - **[Individual Enrollment and Policy Adjustment (POST, PUT)](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. - **[Policy Management for Member Mid-Term Adjustment (POST)](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. - **[Member Policies Adjustment for Contract Endorsement (POST)](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. # Policy Limit Tracking Details Output representation for the insurance policy limit tracking details. ## JSON Example "insPolicyLimitTrackings": \[ { "policyLimitId": "0plxx0000000ABCDEF", "category": "Deductible", "scope": "PerMember", "postedAmount": 750.00, "postedValue": null, "calcInitialAmount": 500.00, "calcInitialValue": null, "remainingAmount": 750.00, "remainingValue": null, "totalUsedAmount": 1250.00, "totalUsedValue": null } \] | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | benefitName | String | Name of the benefit that's associated with the policy limit tracking. | Big, 65.0 | 65.0 | | calcInitial​Amount | Double | Calculated amount that's used as the base value for tracking the policy attribute consumption. | Big, 65.0 | 65.0 | | calcInitial​Value | Integer | Count that's used as the base for tracking the policy attribute consumption. | Big, 65.0 | 65.0 | | category | String | Category of the associated attribute. | Big, 65.0 | 65.0 | | policyLimit​Id | String | ID of the insurance policy limit record. | Big, 65.0 | 65.0 | | postedAmount | Double | Amount that's requested by the claimant when submitting the loss. | Big, 65.0 | 65.0 | | postedValue | Integer | Count that's populated when submitting the loss. | Big, 65.0 | 65.0 | | remaining​Amount | Double | Remaining amount to carry forward for the next loss processing. | Big, 65.0 | 65.0 | | remaining​Value | Integer | Remaining value to carry forward for the next loss processing. | Big, 65.0 | 65.0 | | scope | String | Scope for tracking the associated attribute. | Big, 65.0 | 65.0 | | totalUsed​Amount | Double | Total amount that's used till date. | Big, 65.0 | 65.0 | | totalUsed​Value | Integer | Total value that's used till date. | Big, 65.0 | 65.0 | # Policy Limits (POST) Create insurance policy limit records for the specified policy based on its defined product attributes and coverages. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/generate-limits ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTx0000000001qEAA/generate-limits ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the insurance policy for which the insurance policy limit records must be created. | Required | 65.0 | ## Request Body for POST ### JSON Example { "attributeScopes": { "list": \[ "Policy", "PolicyCoverage" \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeScopes | String\[\] | Attribute scopes for which the policy limit records must be created. Valid values are Policy, PolicyCoverage, Claim, ClaimCoverage. | Optional | 65.0 | ## Response Body for POST [Generate Policy Limits Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_policy_limits.htm "Output representation for the created insurance policy limit records.") # Policy Management for Member Mid-Term 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. 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/policies/member-plan-adjustment ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/policies/member-plan-adjustment ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census whose member plans are updated based on contract mid-term adjustment. The group census type must be eligible for mid-term adjustment. | Required | 68.0 | ## Request Body for POST ### JSON Example { "flowApiName": "Process\_Group\_Census\_Member\_Data", "shouldReprice": true } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowApiName | String | API name of the custom flow to use for bulk member data processing for adjustment operations. If not specified, the default flow is used. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | ## Response Body for POST [Insurance Group Adjustment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_adjustment.htm "Output representation of the details that are returned after a bulk mid-term adjustment request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") # Policy Renewals (POST) 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. ## Resource {censusId} is a placeholder. /connect/insurance/group-censuses/{censusId}/policies/actions/renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rfxx000000001aEAA/policies/actions/renew ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | censusId | String | ID of the group census whose primary members' policies must be renewed. | Required | 68.0 | ## Request Body for POST ### JSON Example { "flowName": "RenewMemberPolicies", "shouldReprice": true } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | flowName | String | API name of the flow to use for member-policy renewal. If not specified, the default RenewMemberPolicies flow is used. | Optional | 68.0 | | shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 | ## Response Body for POST [Insurance Group Renewal Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_renewal.htm "Output representation of the details that are returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") # PolicyLimitStandingCalculation(InsurancePolicyLimitStandingCalculationInput) Calculate the current standing for policy limits. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsPolicyLmtCalcStandingRepresentation PolicyLimitStandingCalculation(ConnectApi.InsPolicyLmtCurrentStandingsInputRep InsurancePolicyLimitStandingCalculationInput) ## Parameters **InsurancePolicyLimitStandingCalculationInput** - Type: [ConnectApi.InsPolicyLmtCurrentStandingsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_policy_lmt_current_standings.htm "Input representation for the current standings of the insurance policy limits.") - Details to calculate the current standings of the insurance policy limits. ## Return Value Type: [ConnectApi.InsPolicyLmtCalcStandingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_policy_lmt_calc_standing.htm "Output representation for the current standings of the insurance policy limits.") # Portal User Creation Input Input representation for the details to create a portal user. ## JSON Example { "profileId": "00e123AbcDefGhiJkl", "emailEncodingKey": "ISO-8859-1", "languageLocaleKey": "en\_US", "localeSidKey": "en\_US", "timeZoneSidKey": "Atlanta" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | emailEncodingKey | String | Email encoding for the user, such as UTF-8 or ISO-8859-1. | Optional | 65.0 | | languageLocaleKey | String | Language for the user, such as en\_US for U.S. English. | Optional | 65.0 | | localeSidKey | String | Locale for the user, which affects the format of dates, times, and numbers. | Optional | 65.0 | | profileId | String | ID of the profile to assign to the new portal user. | Required | 65.0 | | timeZoneSidKey | String | Time zone for the user, such as America or Los\_Angeles. | Optional | 65.0 | # postInsuranceAddMemberPlans(insuranceAddMemberPlansInputRepresentation, memberId) Add plans for a group census member. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceAddMemberPlansOutputRepresentation postInsuranceAddMemberPlans(ConnectApi.InsuranceAddMemberPlansInputRepresentation insuranceAddMemberPlansInputRepresentation, String memberId) ## Parameters **insuranceAddMemberPlansInputRepresentation** - Type: [ConnectApi.InsuranceAddMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_add_member_plans.htm "Input representation for adding plans to a group census member.") - Details to add plans. **memberId** - Type: String - ID of the group census member to add plans for. ## Return Value Type: [ConnectApi.InsuranceAddMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_add_member_plans.htm "Output representation for adding plans to a member.") ## Example Here's an example of how to invoke the Insurance Add Member Plans API from Apex code. // Add Member Plan(s) for a Group Census Member via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceAddMemberPlansInputRepresentation input = new ConnectApi.InsuranceAddMemberPlansInputRepresentation(); // 2) Build one or more member plan entries // Required: contractGroupPlanId (the plan you want to add for the member) // Tip: You don't need to set groupCensusMemberId on each plan here because it's passed as a separate argument. List plans = new List(); ConnectApi.GroupCensusMemberPlanInputRepresentation plan1 = new ConnectApi.GroupCensusMemberPlanInputRepresentation(); plan1.contractGroupPlanId = '0rgxx000000003kAAA'; // e.g., a2Cxx0000001234AAA // Optional fields: // plan1.name = 'Employee Medical Gold'; // plan1.id = 'existingMemberPlanIdIfUpdating'; // not used for add plans.add(plan1); ConnectApi.GroupCensusMemberPlanInputRepresentation plan2 = new ConnectApi.GroupCensusMemberPlanInputRepresentation(); plan2.contractGroupPlanId = '0rgxx000000003jAAA'; // If adding more plans, repeat and add to the list plans.add(plan2); // 3) Wrap plans list into the input // The wrapper expects a list container object input.groupCensusMemberPlans = plans; // 4) Execute the POST API // URL param is the Group Census Member Id the plans will be added to String memberId = '0r6xx00000009CzAAI'; try { ConnectApi.InsuranceAddMemberPlansOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceAddMemberPlans(input, memberId); System.debug('Add Member Plans result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error while adding member plans: ' + e.getMessage()); } # postInsuranceAddMembers(censusMgmtInputParam, groupCensusId) Add new group census members. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceCensusMgmtOutputRepresentation postInsuranceAddMembers(ConnectApi.InsuranceCensusMgmtInputRepresentation censusMgmtInputParam, String groupCensusId) ## Parameters **censusMgmtInputParam** - Type: [ConnectApi.InsuranceCensusMgmtInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_census_mgmt.htm "Input representation for adding or updating census members.") - The input representation containing the census members to add. **groupCensusId** - Type: String - ID of the group census. ## Return Value Type: [ConnectApi.InsuranceCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_mgmt.htm "Output representation for the insurance census management process.") # postInsuranceBulkAddMembers(bulkCensusMgmtInputParam, groupCensusId) Add or update group census member data in bulk. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceBulkCensusMgmtOutputRepresentation postInsuranceBulkAddMembers(ConnectApi.InsuranceBulkCensusMgmtInputRepresentation bulkCensusMgmtInputParam, String groupCensusId) ## Parameters **bulkCensusMgmtInputParam** - Type: [ConnectApi.InsuranceBulkCensusMgmtInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_bulk_census_mgmt.htm "Input representation for managing employee census data in bulk.") - Input representation for the bulk census management process. **groupCensusId** - Type: String - ID of the group census to process members for. ## Return Value Type: [ConnectApi.InsuranceBulkCensusMgmtOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_bulk_census_mgmt.htm "Output representation for the bulk employee census management process.") ## Usage This method corresponds to the /connect/insurance/census-management/group-censuses/groupCensusId/group-census-members/bulk-process REST API endpoint. # postInsuranceCheckPlansEligibility(plansEligibilityInputParam, memberId) Check the eligibility of a group census member for a given set of plans and create a new eligibility context. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePlansEligibilityOutputRepresentation postInsuranceCheckPlansEligibility(ConnectApi.InsurancePlansEligibilityPostInputRepresentation plansEligibilityInputParam, String memberId) ## Parameters **plansEligibilityInputParam** - Type: [ConnectApi.InsurancePlansEligibilityPostInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_plans_eligibility_post.htm "Input representation for checking plan eligibility by creating a new context.") - Input representation that contains the list of plans to check. **memberId** - Type: String - ID of the group census member whose eligibility must be checked. ## Return Value Type: [ConnectApi.InsurancePlansEligibilityOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_plans_eligibility.htm "Output representation for the employee plan eligibility check.") ## Example // Plans Eligibility (POST) via Connect API // 1) Build the input with plans ConnectApi.InsurancePlansEligibilityPostInputRepresentation input = new ConnectApi.InsurancePlansEligibilityPostInputRepresentation(); // Each plan requires a Contract Group Plan Id ConnectApi.InsuranceGroupPlanInputRepresentation plan1 = new ConnectApi.InsuranceGroupPlanInputRepresentation(); plan1.planId = '0rgSG0000000fXPYAY'; // Optionally add coverages under the plan if applicable // plan1.coverages = new List{ /\* coverage items \*/ }; // Provide one or more plans input.plans = new List{ plan1 }; // 2) Execute the POST with the Group Census Member Id String memberId = '0r6SG0000008n3CYAQ'; try { ConnectApi.InsurancePlansEligibilityOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceCheckPlansEligibility( input, memberId ); System.debug('Eligibility (POST) result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Eligibility (POST) error: ' + e.getMessage()); } # postInsuranceContractEndorse(contractEndorseInputParam) Create an endorsed contract version from a quote for a mid-term adjustment. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceContractEndorseRepresentation postInsuranceContractEndorse(ConnectApi.InsuranceContractEndorseInputRepresentation contractEndorseInputParam) ## Parameters **contractEndorseInputParam** - Type: [ConnectApi.InsuranceContractEndorseInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_endorse.htm "Input representation of the quote ID, endorsement effective date, optional date-copy behavior, and additional fields used to create an endorsed contract version from a quote.") - Quote ID, endorsement effective date, optional date-copy behavior, and additional fields used to create the endorsed contract. ## Return Value Type: [ConnectApi.InsuranceContractEndorseRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contract_endorse.htm "Output representation that's returned when an endorsed contract version is created from a quote.") ## Usage Use this method to create an endorsed contract version from a quote. The method carries forward existing contract and contract group plan details and links the new version to the previous contract. Specify the quote in quoteId and the endorsement start date in effectiveDate using yyyy-MM-dd format. Set updateExistingContractDates to true or omit it to copy the source contract end date onto the endorsed contract. Set it to false to skip copying the end date. To stamp additional fields on Contract, InsuranceContract, or ContractGroupPlan, add items to additionalFields. For a contract group plan, set productPath to identify where in the product hierarchy the fields apply. This method runs synchronously. Check isSuccess and contractId on the response. Errors are in the errors property. ## Example This example creates an endorsed contract from a quote, sets the endorsement effective date, and stamps enrollment dates on the insurance contract. // Create an endorsed contract version from a quote. final String SOURCE\_QUOTE\_ID = '0Q0SB000000w6zV0AQ'; final String EFFECTIVE\_DATE = '2026-09-01'; // yyyy-MM-dd // Optional: additional fields for Contract / InsuranceContract / ContractGroupPlan. ConnectApi.InsuranceApexStringRepresentation enrollmentStart = new ConnectApi.InsuranceApexStringRepresentation(); enrollmentStart.key = 'EnrollmentStartDate'; enrollmentStart.value = '2026-09-01'; ConnectApi.InsuranceApexStringRepresentation enrollmentEnd = new ConnectApi.InsuranceApexStringRepresentation(); enrollmentEnd.key = 'EnrollmentEndDate'; enrollmentEnd.value = '2026-09-30'; ConnectApi.InsuranceContractItem insuranceContractItem = new ConnectApi.InsuranceContractItem(); insuranceContractItem.entity = 'InsuranceContract'; // insuranceContractItem.productPath = 'Health/Dental'; insuranceContractItem.fields = new List{ enrollmentStart, enrollmentEnd }; ConnectApi.InsuranceContractEndorseInputRepresentation input = new ConnectApi.InsuranceContractEndorseInputRepresentation(); input.quoteId = SOURCE\_QUOTE\_ID; input.effectiveDate = EFFECTIVE\_DATE; // input.updateExistingContractDates = true; // optional; default true copies source contract end date input.additionalFields = new List{ insuranceContractItem }; try { ConnectApi.InsuranceContractEndorseRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceContractEndorse(input); System.debug('isSuccess: ' + result.isSuccess); System.debug('contractId: ' + result.contractId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while endorsing the contract: ' + e.getMessage()); } # postInsuranceContractRenewal(contractRenewalInputParam) Create a renewed-term group benefits contract from a quote. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceContractRenewalRepresentation postInsuranceContractRenewal(ConnectApi.InsuranceContractRenewalInputRepresentation contractRenewalInputParam) ## Parameters **contractRenewalInputParam** - Type: [ConnectApi.InsuranceContractRenewalInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contract_renewal.htm "Input representation of the quote ID, renewal date, optional contract end date and term, and additional fields used to create a renewed-term contract from a quote.") - Quote ID, renewal date, optional contract end date and term, and additional fields used to create the renewed contract. ## Return Value Type: [ConnectApi.InsuranceContractRenewalRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contract_renewal.htm "Output representation that's returned when a renewed-term contract is created from a quote.") ## Usage Use this method to create a renewed insurance contract from a renewal quote. The method carries forward applicable contract details and line items for the next coverage term. Specify the quote in quoteId and the start of the renewed term in renewalDate using yyyy-MM-dd format. To set the end of the renewed term, use contractEndDate in yyyy-MM-dd format, or set contractTerm in months. The default term is 12 months. To stamp additional fields on Contract, InsuranceContract, or ContractGroupPlan, add items to additionalFields. For a contract group plan, set productPath to identify where in the product hierarchy the fields apply. This method runs synchronously. Check isSuccess and contractId on the response. Errors are in the errors property. ## Example This example creates a renewed-term contract from a quote, sets the renewal date, and stamps an enrollment start date on the insurance contract. // Create a renewed-term contract from a quote. final String SOURCE\_QUOTE\_ID = '0Q0xx0000004C92CAE'; final String RENEWAL\_DATE = '2027-01-01'; // yyyy-MM-dd // Optional: additional fields for Contract / InsuranceContract / ContractGroupPlan. ConnectApi.InsuranceApexStringRepresentation enrollmentStart = new ConnectApi.InsuranceApexStringRepresentation(); enrollmentStart.key = 'EnrollmentStartDate'; enrollmentStart.value = '2027-01-01'; ConnectApi.InsuranceContractItem insuranceContractItem = new ConnectApi.InsuranceContractItem(); insuranceContractItem.entity = 'InsuranceContract'; // insuranceContractItem.productPath = 'Health/Dental'; insuranceContractItem.fields = new List{ enrollmentStart }; ConnectApi.InsuranceContractRenewalInputRepresentation input = new ConnectApi.InsuranceContractRenewalInputRepresentation(); input.quoteId = SOURCE\_QUOTE\_ID; input.renewalDate = RENEWAL\_DATE; // input.contractTerm = 12; // optional; term in months // input.contractEndDate = '2027-12-31'; // optional; yyyy-MM-dd input.additionalFields = new List{ insuranceContractItem }; try { ConnectApi.InsuranceContractRenewalRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceContractRenewal(input); System.debug('isSuccess: ' + result.isSuccess); System.debug('contractId: ' + result.contractId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while renewing the contract: ' + e.getMessage()); } # postInsuranceCreateAccounts(createAccountsInputParam, createPortalUsers) Create person accounts and portal users for group census members. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceAccountsAndUsersCreationRepresentation postInsuranceCreateAccounts(ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation createAccountsInputParam, Boolean createPortalUsers) ## Parameters **createAccountsInputParam** - Type: [ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_accounts_and_users_creation.htm "Input representation for creating person accounts and portal users from group census members.") - Details to create person accounts. **createPortalUsers** - Type: Boolean - Specifies whether to create portal users for the new person accounts (true) or not (false). The default is false. ## Return Value Type: [ConnectApi.InsuranceAccountsAndUsersCreationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_accounts_and_users_creation.htm "Output representation for the person account and user creation process.") ## Example Here's an example of how to invoke the Create Accounts API from Apex code. // Accounts and (optional) Portal Users creation via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation input = new ConnectApi.InsuranceAccountsAndUsersCreationInputRepresentation(); // Provide either a Group Census Id OR a list of Group Census Member Ids // Option A: Use the Group Census Id (creates accounts for all eligible members) // input.groupCensusId = '0rfSG0000000vw7YAA'; // Option B: Or specify specific Group Census Member Ids input.groupCensusMemberIdList = new List{ '0r6SG0000008uTRYAY'}; // Optional: Person Account Record Type Name input.personAccountRecordType = 'Person Account'; // Optional: Matching keys (used to find existing Person Accounts before creating new ones) // input.matchingKeyList = new List{ 'Email', 'ExternalId\_\_c' }; // Optional: Field mappings from Group Census Member fields -> Account fields // Example: map census FirstName/LastName to Person Account fields // input.fieldMappings = new Map{ // 'FirstName' => 'FirstName', // 'LastName' => 'LastName', // 'Email' => 'PersonEmail' // }; // Optional: Provide portal user defaults (only applied if createPortalUsers = true) ConnectApi.PortalUserCreationInputRepresentation userDefaults = new ConnectApi.PortalUserCreationInputRepresentation(); userDefaults.profileId = '00eSG00000JZg4t'; // userDefaults.localeSidKey = 'en\_US'; // userDefaults.timeZoneSidKey = 'America/Los\_Angeles'; // userDefaults.languageLocaleKey = 'en\_US'; // userDefaults.emailEncodingKey = 'UTF-8'; input.userDetails = userDefaults; // 2) Execute the POST API Boolean createPortalUsers = true; // set false to only create accounts try { ConnectApi.InsuranceAccountsAndUsersCreationRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceCreateAccounts( input, createPortalUsers ); System.debug('Accounts and Users creation result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error during accounts/users creation: ' + e.getMessage()); } # postInsuranceCreateCensus(createCensusInputParam, contractId) Generate a group census from the policies on an existing group benefits contract. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGenerateCensusRepresentation postInsuranceCreateCensus(ConnectApi.InsuranceGenerateCensusInputRepresentation createCensusInputParam, String contractId) ## Parameters **createCensusInputParam** - Type: [ConnectApi.InsuranceGenerateCensusInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_census.htm "Input representation of the census name and type, optional policy date, filters, and generation options used to create a group census from the policies on a contract.") - Census name and type, optional policy date, filters, and generation options used to create the group census. **contractId** - Type: String - ID of the insurance contract whose policies are used to generate the group census. ## Return Value Type: [ConnectApi.InsuranceGenerateCensusRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_generate_census.htm "Output representation that's returned when you start generating a group census from the policies on a group benefits contract.") ## Usage Use this method to generate a group census from the policies on an existing group benefits contract. Specify the contract in contractId and the census type in censusType, such as Enrollment or Quote. Optionally set censusName. This method runs asynchronously and returns a requestId that you can use to track the job. To retry a failed run, pass that requestId on the next call. Set policyEffectiveDate in yyyy-MM-dd format to select the policy version. The date must fall between the version's effectiveFromDate and effectiveToDate. Use filter to limit the census to root contract group plans, contacts, or person accounts. Set shouldGenerateCsv to create a CSV file of the census details. Set shouldIncludeMemberPlans to include insurance plan details for each member. Check isSuccess, groupCensusId, and requestId on the response. Errors are in the errors property. ## Example This example starts generating an enrollment census from a contract, filters by person account, and includes member plan details and a CSV file. // Generate a group census from the policies on a contract. final String CONTRACT\_ID = '800SB00001I80hWYAR'; // Optional: filter by members and/or root contract group plans. ConnectApi.InsuranceCensusFilterInputRepresentation filter = new ConnectApi.InsuranceCensusFilterInputRepresentation(); filter.objectName = 'PersonAccount'; // Contact or PersonAccount filter.recordIds = new List{ '001SB00001xuR1RYAU' }; // filter.contractGroupPlanIds = new List{ /\* CGP ids \*/ }; ConnectApi.InsuranceGenerateCensusInputRepresentation input = new ConnectApi.InsuranceGenerateCensusInputRepresentation(); input.censusName = 'apex\_Census'; input.censusType = 'Enrollment'; // e.g. System, Quote, Enrollment, Lead, Renewal // input.policyEffectiveDate = '2027-09-01'; // yyyy-MM-dd input.shouldGenerateCsv = true; input.shouldIncludeMemberPlans = true; input.filter = filter; // input.requestId = '08Pxx0000000001EAA'; // only to retry a previously failed job try { ConnectApi.InsuranceGenerateCensusRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceCreateCensus(input, CONTRACT\_ID); System.debug('isSuccess: ' + result.isSuccess); System.debug('groupCensusId: ' + result.groupCensusId); System.debug('requestId: ' + result.requestId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while generating the census: ' + e.getMessage()); } # postInsuranceCreateContacts(createContactsInputParam, createPortalUsers) Create contacts and portal users for group census members. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceContactsAndUsersCreationRepresentation postInsuranceCreateContacts(ConnectApi.InsuranceContactsAndUsersCreationInputRepresentation createContactsInputParam, Boolean createPortalUsers) ## Parameters **createContactsInputParam** - Type: [ConnectApi.InsuranceContactsAndUsersCreationInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_contacts_and_users_creation.htm "Input representation to create contacts and portal users.") - Details to create contacts and users. **createPortalUsers** - Type: Boolean - Indicates whether to create portal users for the new contacts (true) or not (false). The default value is false. ## Return Value Type: [ConnectApi.InsuranceContactsAndUsersCreationRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_contacts_and_users_creation.htm "Output representation of the contact and user creation process.") ## Example Here's an example of how to invoke the Insurance Create Contracts API from Apex code. // Create Group Benefits Contract via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceContractCreationInputRepresentation input = new ConnectApi.InsuranceContractCreationInputRepresentation(); // Required: Quote Id to convert input.quoteId = '0Q0xx0000004C9QCAU'; // Optional dates (ISO-8601 strings) input.contractStartDate = '2026-01-01'; input.contractEndDate = '2026-12-31'; input.enrollmentStartDate = '2025-12-01'; input.enrollmentEndDate = '2025-12-31'; // Optional: contract term in months // input.contractTerm = 12; // 2) (Optional) Additional fields per contract item (e.g., per quote line) // Build a map-like structure using InsuranceApexStringMapInputRepresentation List fieldPairs = new List(); ConnectApi.InsuranceApexStringRepresentation kv1 = new ConnectApi.InsuranceApexStringRepresentation(); kv1.key = 'CustomerSignedTitle'; kv1.value = 'Mr'; fieldPairs.add(kv1); // One contract item (repeat and add to the list for more) ConnectApi.ContractItem item = new ConnectApi.ContractItem(); item.entity = 'Contract'; // e.g., 'ContractLineItem\_\_c' (use your org’s API name) // item.instanceKey = 'QLI-1'; // unique identification key from Quote Line Item item.fields = fieldPairs; // Wrap into list and assign to input.additionalFields input.additionalFields = new List{ item }; // 3) Execute the Contract Creation API try { ConnectApi.InsuranceContractCreationOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceGBQuoteToContract(input); System.debug('Contract creation result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error while creating contract: ' + e.getMessage()); } # postInsuranceCreateQuoteFromContract(createQuoteFromContractInputParam, contractId) Create a quote from an existing insurance contract, including the quote structure and line items. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceCreateQuoteFromContractOutputRepresentation postInsuranceCreateQuoteFromContract(ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation createQuoteFromContractInputParam, String contractId) ## Parameters **createQuoteFromContractInputParam** - Type: [ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_create_quote_from_contract.htm "Input representation for creating a quote from an existing insurance contract.") - Input details used to create the quote from the contract, including effective dates, transaction type, census information, and optional configuration options. **contractId** - Type: String - ID of the insurance contract used to create the quote. ## Return Value Type: [ConnectApi.InsuranceCreateQuoteFromContractOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_create_quote_from_contract_output.htm "Output representation returned when creating a quote from an existing insurance contract.") ## Usage Use this method to create a quote from an existing insurance contract, including the quote structure and line items. Specify the contract in contractId. All properties on the input representation are optional. Set quoteName, transactionType (such as GB Endorsement or GB Renewal), and insuranceQuoteType (such as Endorsement or Renewal) on the quote. Use eventEffectiveFromDate and eventEffectiveToDate in yyyy-MM-dd format. Associate a census with groupCensusId. To apply field overrides to Quote or QuoteLineItem, add items to additionalFields. Each item identifies the entity, optional productPath, and fields as key-value pairs. Set configOptions to control whether configuration and qualification rules run. Check isSuccess and quoteId on the response. Errors are in the errors property. ## Example This example creates a quote from an existing contract. It sets quote name, transaction type, effective dates, and census, and it applies an optional line-item field override. // Create a quote from an existing contract. final String CONTRACT\_ID = '800SB00001IhQijYAF'; // Optional: field overrides for Quote / QuoteLineItem. ConnectApi.InsuranceApexStringRepresentation field = new ConnectApi.InsuranceApexStringRepresentation(); field.key = 'PlanAllocationType\_\_std'; field.value = 'Restrictive'; ConnectApi.InsuranceQuoteItem quoteItem = new ConnectApi.InsuranceQuoteItem(); quoteItem.entity = 'QuoteLineItem'; quoteItem.productPath = 'ciBasic'; quoteItem.fields = new List{ field }; // Optional: configuration and qualification rules. ConnectApi.InsGBQuoteConfigOptions configOptions = new ConnectApi.InsGBQuoteConfigOptions(); configOptions.executeConfigurationRules = false; configOptions.executeQualificationRules = false; ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation input = new ConnectApi.InsuranceCreateQuoteFromContractInputRepresentation(); input.quoteName = 'Apex Generated Quote'; input.transactionType = 'GB Endorsement'; // e.g. GB Endorsement, GB Renewal input.insuranceQuoteType = 'GroupRenewal'; // e.g. Endorsement, Renewal input.eventEffectiveFromDate = '2027-09-01'; // yyyy-MM-dd input.eventEffectiveToDate = '2028-08-31'; // yyyy-MM-dd input.groupCensusId = '0rfSB0000004eA9YAI'; // input.ratingDate = '2026-09-01'; // input.censusRatingType = 'Member Based'; // e.g. Member Based, Summary Based input.configOptions = configOptions; input.additionalFields = new List{ quoteItem }; try { ConnectApi.InsuranceCreateQuoteFromContractOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceCreateQuoteFromContract(input, CONTRACT\_ID); System.debug('isSuccess: ' + result.isSuccess); System.debug('quoteId: ' + result.quoteId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while creating a quote from the contract: ' + e.getMessage()); } # postInsuranceDeleteMemberPlans(insuranceDeleteMemberPlansInputRepresentation, memberId) Delete the specified plans for a group census member. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceDeleteMemberPlansOutputRepresentation postInsuranceDeleteMemberPlans(ConnectApi.InsuranceDeleteMemberPlansInputRepresentation insuranceDeleteMemberPlansInputRepresentation, String memberId) ## Parameters **insuranceDeleteMemberPlansInputRepresentation** - Type: [ConnectApi.InsuranceDeleteMemberPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_delete_member_plans.htm "Input representation for deleting a member's plans.") - The input representation containing the list of plans to delete. **memberId** - Type: String - ID of the group census member whose plans are being deleted. ## Return Value Type: [ConnectApi.InsuranceDeleteMemberPlansOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_delete_member_plans.htm "Output representation for the member plan deletion process.") ## Example Here's an example of how to invoke the Insurance Delete Member Plans API from Apex code. // Delete Member Plan(s) for a Group Census Member via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceDeleteMemberPlansInputRepresentation input = new ConnectApi.InsuranceDeleteMemberPlansInputRepresentation(); // 2) Provide the list of existing Group Census Member Plan record Ids to delete // Uses a simple string list wrapper List planIdsToDelete = new List{ '0rgxx000000003LAAQ', '0rgxx000000003UAAQ' }; input.plans = planIdsToDelete; // 3) Execute the POST Delete Member Plans API // URL param is the Group Census Member Id whose plans you want to delete String memberId = '0r6xx00000004LGAAY'; try { ConnectApi.InsuranceDeleteMemberPlansOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceDeleteMemberPlans(input, memberId); System.debug('Delete Member Plans result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error while deleting member plans: ' + e.getMessage()); } # postInsuranceGenerateRefreshCensusMembers(generateRefreshCensusMembersInputParam, contractId) Generate or update group census members from policy information on an existing group benefits contract. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGenerateRefreshCensusMembersRep postInsuranceGenerateRefreshCensusMembers(ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep generateRefreshCensusMembersInputParam, String contractId) ## Parameters **generateRefreshCensusMembersInputParam** - Type: [ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_generate_refresh_census_members.htm "Input representation of the census details, member identifiers, optional policy date, and additional fields used to generate or update group census members from policy information on a contract.") - Census details, member identifiers, optional policy date, and additional fields used to generate or update group census members. **contractId** - Type: String - ID of the insurance contract whose policy data is used to generate or update group census member information. ## Return Value Type: [ConnectApi.InsuranceGenerateRefreshCensusMembersRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_generate_refresh_census_members.htm "Output representation that's returned when you generate or update group census members from policy information on a group benefits contract.") ## Usage Use this method to generate or update group census members and their plan configuration details from policy information on an existing group benefits contract. Specify the contract in contractId. Identify members with personAccountIds or contactIds. If you specify contact IDs, also set policyIds. To update members on an existing census, set groupCensusId. To create a census, set censusName and censusType, such as Enrollment or Quote. Set policyEffectiveDate in yyyy-MM-dd format to select the policy version. The date must fall between the version's effectiveFromDate and effectiveToDate. Set shouldGenerateCsv to create a CSV file of the census data. Set shouldIncludeMemberPlans to include insurance plan details for each member. To stamp additional field values on members, set additionalFields with a list of members and their fields. Check isSuccess and groupCensusId on the response. Errors are in the errors property. ## Example This example generates census members from a contract for a person account, includes member plan details, and stamps an additional field on the member. // Generate or update group census members from policy information on a contract. final String CONTRACT\_ID = '800SB00001HNnddYAD'; // Optional: additional field values per member. ConnectApi.InsuranceApexStringRepresentation sourceSystem = new ConnectApi.InsuranceApexStringRepresentation(); sourceSystem.key = 'SourceSystemIdentifier'; sourceSystem.value = 'new'; ConnectApi.InsuranceUpsertMemberRep member = new ConnectApi.InsuranceUpsertMemberRep(); member.memberId = '001SB00001wg2zZYAQ'; member.fields = new List{ sourceSystem }; ConnectApi.InsuranceGenerateRefreshCensusMembersAdditionalFieldsRep additionalFields = new ConnectApi.InsuranceGenerateRefreshCensusMembersAdditionalFieldsRep(); additionalFields.members = new List{ member }; ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep input = new ConnectApi.InsuranceGenerateRefreshCensusMembersInputRep(); input.censusName = 'sync\_censuS\_apex'; input.censusType = 'Enrollment'; // e.g. System, Quote, Enrollment, Lead, Renewal // input.groupCensusId = '0rfSB000000505pYAA'; // set to refresh members on an existing census input.personAccountIds = new List{ '001SB00001wg2zZYAQ' }; // input.contactIds = new List{ /\* Contact IDs — require policyIds to resolve \*/ }; // input.policyIds = new List{ /\* Policy IDs to source member info for the contacts \*/ }; input.policyEffectiveDate = '2026-12-12'; input.shouldIncludeMemberPlans = true; input.additionalFields = additionalFields; try { ConnectApi.InsuranceGenerateRefreshCensusMembersRep result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceGenerateRefreshCensusMembers(input, CONTRACT\_ID); System.debug('isSuccess: ' + result.isSuccess); System.debug('groupCensusId: ' + result.groupCensusId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while generating or updating census members: ' + e.getMessage()); } # postInsuranceGroupEndorsement(censusId, insuranceGroupEndorsementInputRepresentation) Apply mid-term contract adjustments to the eligible member policies in a group census. Use this method after an endorsed contract version is created so that member policies reflect the contract changes. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGroupEndorsementRepresentation postInsuranceGroupEndorsement(String censusId, ConnectApi.InsuranceGroupEndorsementInputRepresentation insuranceGroupEndorsementInputRepresentation) ## Parameters **censusId** - Type: String - ID of the group census whose eligible member policies are updated based on the contract mid-term adjustment. **insuranceGroupEndorsementInputRepresentation** - Type: [ConnectApi.InsuranceGroupEndorsementInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_endorsement.htm "Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census.") - Optional flow and repricing settings that are used to apply the contract adjustments to member policies. ## Return Value Type: [ConnectApi.InsuranceGroupEndorsementRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_endorsement.htm "Output representation that's returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") ## Usage Use this method to apply mid-term contract adjustments to the eligible member policies in a group census. Specify the census in censusId. All properties on the input representation are optional. To use a custom flow, set flowName to the flow's API name. If you omit flowName, the method uses ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy. Set shouldReprice to false to keep the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. The census upload must be finished before you apply the adjustment. The method runs asynchronously. Use the requestId in the response to track the job. Errors that occur while validating or scheduling the job are in the errors property. ## Example This example applies mid-term contract adjustments to the eligible member policies in a group census and recalculates premiums. Complete the census upload before you run this method. // Apply mid-term contract adjustments to eligible member policies. // The census upload must be finished before adjusting. final String CENSUS\_ID = '0rfxx000000022IAAQ'; ConnectApi.InsuranceGroupEndorsementInputRepresentation input = new ConnectApi.InsuranceGroupEndorsementInputRepresentation(); input.shouldReprice = true; // input.flowName = 'ind\_ins\_grpben\_\_ApplyCntrAdjMbrPlcy'; // optional; omit to use the default flow try { ConnectApi.InsuranceGroupEndorsementRepresentation result = ConnectApi.GroupBenefitsApi.postInsuranceGroupEndorsement(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while applying contract adjustments: ' + e.getMessage()); } This example uses the default flow and the default repricing behavior (shouldReprice is true). // Apply mid-term contract adjustments with defaults: default flow, shouldReprice = true. final String CENSUS\_ID = '0rfxx000000022IAAQ'; ConnectApi.InsuranceGroupEndorsementInputRepresentation input = new ConnectApi.InsuranceGroupEndorsementInputRepresentation(); try { ConnectApi.InsuranceGroupEndorsementRepresentation result = ConnectApi.GroupBenefitsApi.postInsuranceGroupEndorsement(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while applying contract adjustments: ' + e.getMessage()); } # postInsuranceGroupRating(gbGroupRatingInputParam, quoteId) Rate a group benefits quote to calculate premiums for all quote line items. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGroupRatingOutputRepresentation postInsuranceGroupRating(ConnectApi.InsuranceGroupRatingInputRepresentation gbGroupRatingInputParam, String quoteId) ## Parameters **gbGroupRatingInputParam** - Type: [ConnectApi.InsuranceGroupRatingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_rating.htm "Input representation for rating a group benefits quote.") - The details required for the group rating process. **quoteId** - Type: String - ID of the quote to perform the group rating on. ## Return Value Type: [ConnectApi.InsuranceGroupRatingOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_rating.htm "Output representation for the group benefits rating process.") ## Example Here's an example of how to invoke the Insurance Group Rating API from Apex code. // Group Rating via Connect API (simple version) // 1) Build the input ConnectApi.InsuranceGroupRatingInputRepresentation input = new ConnectApi.InsuranceGroupRatingInputRepresentation(); // Required: Quote Line Item Ids to rate // input.quoteLineItemIds = new List{ // '0QLxx00000001A1AAY', '0QLxx00000001A2AAY' // }; // Optional: Rating date (ISO-8601, e.g., 2025-11-26) input.ratingDate = '2025-11-26T14:19:30.000'; // Optional: Batch size (process quote line items in batches) // input.batchSize = 100; // 2) Execute the POST API with the Quote Id String quoteId = '0Q0SG000000PcEz0AK'; // Quote Id (type 0Q0) try { ConnectApi.InsuranceGroupRatingOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceGroupRating( input, quoteId ); System.debug('Group Rating success: ' + result.isSuccess); System.debug('Errors: ' + JSON.serializePretty(result.errors)); } catch (Exception e) { System.debug('Group Rating error: ' + e.getMessage()); } # postInsuranceGroupRenewal(censusId, insuranceGroupRenewalInputRepresentation) Renew insurance policies of group census members for a contract renewal. Use this method to create insurance policies under the renewed contract for each primary census member, link the new policies to their previous policies, and record renewal transactions. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceGroupRenewalRepresentation postInsuranceGroupRenewal(String censusId, ConnectApi.InsuranceGroupRenewalInputRepresentation insuranceGroupRenewalInputRepresentation) ## Parameters **censusId** - Type: String - ID of the group census whose primary members' policies must be renewed. **insuranceGroupRenewalInputRepresentation** - Type: [ConnectApi.InsuranceGroupRenewalInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_group_renewal.htm "Input representation of the optional flow and repricing settings used to renew member policies for a group census.") - Optional flow and repricing settings that are used to renew member policies. ## Return Value Type: [ConnectApi.InsuranceGroupRenewalRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_group_renewal.htm "Output representation that's returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job.") ## Usage Use this method to renew insurance policies of group census members for a contract renewal. Specify a group census whose type is Renewal in censusId. All properties on the input representation are optional. To use a custom flow, set flowName to the flow's API name. If you omit flowName, the method uses the default RenewMemberPolicies flow. Set shouldReprice to false to keep the premiums from the existing GroupCensusMemberPlan records instead of recalculating them. The default value is true. The method runs asynchronously. It creates insurance policies under the renewed contract for each primary census member, links the new policies to their previous policies, and records renewal transactions. Use the requestId in the response to track the job. Errors that occur while validating or scheduling the job are in the errors property. ## Example This example renews member policies for a group census whose type is Renewal. It uses the RenewMemberPolicies flow and reuses existing GroupCensusMemberPlan premiums instead of recalculating them. Provide only the input properties that you want to override. // Renew member policies for a contract renewal. // The group census type must be Renewal. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String RENEWAL\_FLOW = 'RenewMemberPolicies'; // optional; default flow when omitted ConnectApi.InsuranceGroupRenewalInputRepresentation input = new ConnectApi.InsuranceGroupRenewalInputRepresentation(); input.flowName = RENEWAL\_FLOW; // optional — omit to use the default RenewMemberPolicies flow input.shouldReprice = false; // optional — default true; false reuses existing GCMP premiums try { ConnectApi.InsuranceGroupRenewalRepresentation result = ConnectApi.GroupBenefitsApi.postInsuranceGroupRenewal(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while renewing member policies: ' + e.getMessage()); } This example renews with the default RenewMemberPolicies flow and repricing on (shouldReprice is true). The entire input is optional in this example. // Renew member policies with defaults: RenewMemberPolicies flow, shouldReprice = true. final String CENSUS\_ID = '0rfxx000000022IAAQ'; ConnectApi.InsuranceGroupRenewalInputRepresentation input = new ConnectApi.InsuranceGroupRenewalInputRepresentation(); try { ConnectApi.InsuranceGroupRenewalRepresentation result = ConnectApi.GroupBenefitsApi.postInsuranceGroupRenewal(CENSUS\_ID, input); System.debug('requestId: ' + result.requestId); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while renewing member policies: ' + e.getMessage()); } # postInsuranceIndividualEnrollment(insuranceIndividualEnrollmentInputParam, memberId) Enroll a group census member in one or more insurance plans, creating the necessary policy records. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceIndividualEnrollmentOutputRepresentation postInsuranceIndividualEnrollment(ConnectApi.InsuranceIndividualEnrollmentInputRepresentation insuranceIndividualEnrollmentInputParam, String memberId) ## Parameters **insuranceIndividualEnrollmentInputParam** - Type: [ConnectApi.InsuranceIndividualEnrollmentInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_individual_enrollment.htm "Input representation for enrolling an individual member.") - Details of the plans to enroll the member in. **memberId** - Type: String - ID of the Group Census Member to enroll. ## Return Value Type: [ConnectApi.InsuranceIndividualEnrollmentOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_individual_enrollment.htm "Output representation for the individual enrollment process.") ## Example Here's an example of how to invoke the Individual Enrollment API from Apex code. // Individual Enrollment via Connect API (simple version) // 1) Create the top-level input ConnectApi.InsuranceIndividualEnrollmentInputRepresentation input = new ConnectApi.InsuranceIndividualEnrollmentInputRepresentation(); // Required: target plan (Contract Group Plan Id) input.plan = '0rgxx00000000CcAAI'; // Optional: specify a processing flow if your org uses one // input.flowName = 'DefaultEnrollmentFlow'; // Optional: recalculate premiums (default true). Set to false to reuse // premiums from existing GroupCensusMemberPlan records. input.shouldReprice = true; // 2) Execute the POST API with the Group Census Member Id String memberId = '0r6xx00000007G2AAI'; try { ConnectApi.InsuranceIndividualEnrollmentOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceIndividualEnrollment(input, memberId); System.debug('Individual Enrollment result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error during individual enrollment: ' + e.getMessage()); } # postInsuranceIssueContract(issueContractInputParam) Issue a group benefits contract from a quote synchronously to activate coverage. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceIssueContractRepresentation postInsuranceIssueContract(ConnectApi.InsuranceIssueContractInputRepresentation issueContractInputParam) ## Parameters **issueContractInputParam** - Type: [ConnectApi.InsuranceIssueContractInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_issue_contract.htm "Input representation of the quote ID, optional contract dates and term, transaction detail level, and additional fields used to issue a group benefits contract from a quote.") - Quote ID and optional contract dates, term, transaction detail level, and additional fields used to issue the contract. ## Return Value Type: [ConnectApi.InsuranceIssueContractRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_issue_contract.htm "Output representation that's returned when a group benefits contract is issued synchronously from a quote.") ## Usage Use this method to issue a group benefits contract from a quote synchronously. Specify the quote in quoteId. To override dates derived from the quote, set contractStartDate and contractEndDate in yyyy-MM-dd format, or set contractTerm in months. Set transactionDetailLevel to PLAN\_LEVEL, COVERAGE\_LEVEL, or CHARGE\_LEVEL. The default value is PLAN\_LEVEL. To stamp additional fields on Contract, InsuranceContract, or ContractGroupPlan, add items to additionalFields. For a contract group plan, set productPath to identify where in the product hierarchy the fields apply. This method runs synchronously. Check isSuccess and contractId on the response. Errors are in the errors property. ## Example This is a sample example that shows how to issue a contract from a quote, overrides the contract dates, sets plan-level transaction detail, and applies an enrollment start date on the insurance contract from Apex code. // Issue a group benefits contract from a quote. final String SOURCE\_QUOTE\_ID = '0Q0SB000000w6zV0AQ'; // Optional: additional fields for Contract / InsuranceContract / ContractGroupPlan. ConnectApi.InsuranceApexStringRepresentation enrollmentStart = new ConnectApi.InsuranceApexStringRepresentation(); enrollmentStart.key = 'EnrollmentStartDate'; enrollmentStart.value = '2026-09-01'; ConnectApi.InsuranceContractItem insuranceContractItem = new ConnectApi.InsuranceContractItem(); insuranceContractItem.entity = 'InsuranceContract'; // insuranceContractItem.productPath = 'Health/Dental'; insuranceContractItem.fields = new List{ enrollmentStart }; ConnectApi.InsuranceIssueContractInputRepresentation input = new ConnectApi.InsuranceIssueContractInputRepresentation(); input.quoteId = SOURCE\_QUOTE\_ID; input.contractStartDate = '2026-09-01'; // optional; yyyy-MM-dd input.contractEndDate = '2027-08-31'; // optional; yyyy-MM-dd // input.contractTerm = 12; // optional input.transactionDetailLevel = 'PLAN\_LEVEL'; // optional; PLAN\_LEVEL | COVERAGE\_LEVEL | CHARGE\_LEVEL input.additionalFields = new List{ insuranceContractItem }; try { ConnectApi.InsuranceIssueContractRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceIssueContract(input); System.debug('isSuccess: ' + result.isSuccess); System.debug('contractId: ' + result.contractId); System.debug('message: ' + result.message); System.debug('errors: ' + result.errors); } catch (Exception e) { System.debug('Error while issuing the contract: ' + e.getMessage()); } # postInsuranceMembersRating(insuranceMemberRatingInputParam, memberId) Calculate pricing for individual members of a group census, with the support for plan and individual coverages within the plan. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceMemberRatingRepresentation postInsuranceMembersRating(ConnectApi.InsuranceMemberRatingInputRepresentation insuranceMemberRatingInputParam, String memberId) ## Parameters **insuranceMemberRatingInputParam** - Type: [ConnectApi.InsuranceMemberRatingInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_member_rating.htm "Input representation for the individual member rating API.") - Input representation for rating the members. **memberId** - Type: String - ID of the group census member. ## Return Value Type: [ConnectApi.InsuranceMemberRatingRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_member_rating.htm "Output representation of the rating results for individual members.") ## Example Here's an example of how to invoke the Insurance Member Rating API from Apex code. // Individual Member Rating via Connect API (simple version) // 1) Build the input ConnectApi.InsuranceMemberRatingInputRepresentation input = new ConnectApi.InsuranceMemberRatingInputRepresentation(); // Optional: Effective date (ISO-8601) input.effectiveDate = '2025-11-26T15:26:00.000'; // Members to rate (one or more) ConnectApi.InsuranceMemberRatingDetailsInputRepresentation memberDetails = new ConnectApi.InsuranceMemberRatingDetailsInputRepresentation(); memberDetails.memberId = '0r6SG0000008n8XYAQ'; // member to rate // Plan(s) to rate for this member ConnectApi.InsuranceMemberRatingPlansInputRepresentation plan = new ConnectApi.InsuranceMemberRatingPlansInputRepresentation(); plan.planId = '0rgSG0000000fgIYAQ'; plan.planCoverageIds = new List{ '0rgSG0000000fgJYAQ' }; // Assign plans to the member and add to input memberDetails.plans = new List{ plan }; input.members = new List{ memberDetails }; // 2) Execute the POST API with the primary Group Census Member Id (family anchor) String primaryMemberId = '0r6SG0000008n8OYAQ'; try { ConnectApi.InsuranceMemberRatingRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceMembersRating( input, primaryMemberId ); System.debug('Member Rating ID: ' + result.id); System.debug('Pricing Results: ' + JSON.serializePretty(result.pricingResults)); System.debug('Errors: ' + JSON.serializePretty(result.errors)); } catch (Exception e) { System.debug('Member Rating error: ' + e.getMessage()); } # postInsuranceSyncCensusSummary(groupCensusId) Synchronize and recalculate the summary data for a group census. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceCensusSummarySyncOutputRepresentation postInsuranceSyncCensusSummary(ConnectApi.InsuranceCensusSummarySyncInputRepresentation censusSummarySyncInputParam, String groupCensusId) ## Parameters **groupCensusId** - Type: String - ID of the group census to synchronize. ## Return Value Type: [ConnectApi.InsuranceCensusSummarySyncOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_census_summary_sync.htm "Output representation for the insurance employee census summary synchronization process.") ## Example Here's an example of how to invoke the Insurance Sync Census Summary API from Apex code. // Census Summary Sync via Connect API (simple version) // 1) Create the top-level input (no fields required) ConnectApi.InsuranceCensusSummarySyncInputRepresentation input = new ConnectApi.InsuranceCensusSummarySyncInputRepresentation(); // 2) Execute the POST API with the Group Census Id String groupCensusId = '0rfxx000000000RAAQ'; try { ConnectApi.InsuranceCensusSummarySyncOutputRepresentation result = ConnectApi.InsuranceGroupBenefitsFamily.postInsuranceSyncCensusSummary(input, groupCensusId); System.debug('Census Summary Sync result: ' + JSON.serializePretty(result)); } catch (Exception e) { System.debug('Error during Census Summary Sync: ' + e.getMessage()); } # postVerifyPolicyCoverage(policyId, coverageId, verifyPolicyCoverageInput) Verify the applicability of a policy coverage for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.VerifyPolicyCoverageRepresentation postVerifyPolicyCoverage(String policyId, String coverageId, ConnectApi.VerifyPolicyCoverageInputRepresentation verifyPolicyCoverageInput) ## Parameters **policyId** - Type: String - ID of the insurance policy. **coverageId** - Type: String - ID of the policy coverage to verify. **verifyPolicyCoverageInput** - Type: [ConnectApi.VerifyPolicyCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_verify_policy_coverage.htm "Input representation for verifying a policy coverage's applicability for a specified loss date.") - JSON object that contains the loss date and other details for verification. ## Return Value Type: [ConnectApi.VerifyPolicyCoverageRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_verify_policy_coverage.htm "Output representation of a policy coverage's applicability for a specified loss date.") ## Example Use the VerifyPolicyCoverageCallable Apex class to validate whether a given insurance policy provides coverage for a specific insured asset or participant on a given loss date. This class wraps the Connect API endpoint /connect/insurance/policies/{policyId}/coverages/{coverageId}/verify. You can call this method from Apex to automate coverage verification during claim workflows. **Class Definition** public with sharing class VerifyPolicyCoverageCallable implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'verifyPolicyCoverage') { ConnectApi.VerifyPolicyCoverageInputRepresentation verificationInput = (ConnectApi.VerifyPolicyCoverageInputRepresentation) inputMap.get('verificationInput'); System.debug('Start of connect API call to verify policy coverage'); ConnectApi.VerifyPolicyCoverageRepresentation verificationData; try { verificationData = ConnectApi.InsuranceClaimFamily.postVerifyPolicyCoverage( '0YTxx000000000DGAQ', // policyId '0cYxx000000012IEAQ', // coverageId verificationInput ); System.debug('Policy coverage verification completed: ' + verificationData); outputMap.put('verificationData', verificationData); } catch (Exception e) { System.debug('Error while verifying policy coverage: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return verificationData; } return null; } } **Usage Example** VerifyPolicyCoverageCallable callable = new VerifyPolicyCoverageCallable(); // Prepare input Map input = new Map(); ConnectApi.VerifyPolicyCoverageInputRepresentation verificationInput = new ConnectApi.VerifyPolicyCoverageInputRepresentation(); verificationInput.lossDate = '2025-08-15'; verificationInput.insuredAssetOrParticipantId = '0YWxx00000000P5GAI'; input.put('verificationInput', verificationInput); // Prepare output and args Map output = new Map(); Map args = new Map{ 'input' => input, 'output' => output }; // Call the 'verifyPolicyCoverage' action Object result = callable.call('verifyPolicyCoverage', args); ConnectApi.VerifyPolicyCoverageRepresentation verificationData = (ConnectApi.VerifyPolicyCoverageRepresentation) result; // Log verification result System.debug('Policy Coverage Verification Result: ' + JSON.serializePretty(verificationData)); // Check for success if (verificationData.isSuccess) { System.debug('Policy coverage is valid for the specified loss date'); } else { System.debug('Policy coverage verification failed. Errors:'); for (ConnectApi.ErrorDetail error : verificationData.errors) { System.debug('Error Code: ' + error.errorCode + ', Message: ' + error.message); } } // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # Premium Preview Amounts Contains the ten rolled-up Standard and Term premium amount fields returned for a single policy-hierarchy node during a draft-state premium preview. ## JSON Example { "standardPremium": 2164, "standardFee": 25, "standardTax": 15, "standardCommission": 0, "totalStandard": 2204, "termPremium": 2164, "termFee": 25, "termTax": 15, "termCommission": 0, "totalTerm": 2204 } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | standardCommission | Double | Standard commission amount rolled up for the hierarchy node. The value is computed by summing the node’s children (or the node’s own entered amount for a leaf coverage). | Small, 68.0 | 68.0 | | standardFee | Double | Standard fee amount rolled up for the hierarchy node. | Small, 68.0 | 68.0 | | standardPremium | Double | Standard (typically annualized) premium amount rolled up for the hierarchy node. | Small, 68.0 | 68.0 | | standardTax | Double | Standard tax amount rolled up for the hierarchy node. | Small, 68.0 | 68.0 | | termCommission | Double | Term commission amount rolled up for the hierarchy node after day-based proration across the policy term. | Small, 68.0 | 68.0 | | termFee | Double | Term fee amount rolled up for the hierarchy node after day-based proration. | Small, 68.0 | 68.0 | | termPremium | Double | Term premium amount rolled up for the hierarchy node after day-based proration. | Small, 68.0 | 68.0 | | termTax | Double | Term tax amount rolled up for the hierarchy node after day-based proration. | Small, 68.0 | 68.0 | | totalStandard | Double | Total standard amount for the node, calculated as standard premium plus standard tax plus standard fee. For surcharge nodes, only this field and totalTerm are populated; the component fields are null. | Small, 68.0 | 68.0 | | totalTerm | Double | Total term amount for the node, calculated as term premium plus term tax plus term fee. For surcharge nodes, only this field and totalStandard are populated; the component fields are null. | Small, 68.0 | 68.0 | # Premium Preview Input Input representation of the policy-hierarchy nodes to include in a draft-state premium preview. Omit or leave empty to return only the policy-level (root) rolled-up amounts. ## JSON Example { "references": { "references": \[ { "recordId": "0cYxx00000000ODEAY" }, { "recordId": "0cYxx00000000MbEAI" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | references | [Premium Preview Reference Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_premium_preview_reference.htm "Input representation of a node within the insurance policy hierarchy whose rolled-up premium amounts you want to compute.")\[\] | List of hierarchy-node references to compute. If omitted or empty, the API returns only the root policy level amounts. Supports up to 2000 node references. Results are returned in the same order as this list. | Optional | 68.0 | # Premium Preview Reference Input Input representation of a node within the insurance policy hierarchy whose rolled-up premium amounts you want to compute. ## JSON Example { "recordId": "0YWxx00000000CvGAI" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | recordId | String | ID of the policy-hierarchy node to compute. Valid node types include the insurance policy, Insurance Policy Asset (IPA), Insurance Policy Participant (IPP), Insurance Policy Coverage (IPC), or surcharge. | Optional | 68.0 | # Premium Preview Response Output representation of the details of the draft-state premium preview results for an insurance policy, including per-node rolled-up amounts and any errors. ## JSON Example This example shows a whole-policy preview success response when references is omitted. { "errors": \[\], "policyId": "0YTfiP000000FdNGBU", "results": \[ { "amounts": { "standardCommission": 0, "standardFee": 0, "standardPremium": 3000, "standardTax": 0, "termCommission": 0, "termFee": 0, "termPremium": 3000, "termTax": 0, "totalStandard": 3000, "totalTerm": 3000 }, "errors": \[\], "name": "Draft State Premium Dummy Policy -1", "recordId": "0YTfiP000000FdNGBU" } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | Error details for the entire request, such as NOT\_FOUND, batch-limit failures, or proration failures that stop the request. Shows null on success. | Small, 68.0 | 68.0 | | policyId | String | ID of the insurance policy the premium preview is computed for. | Small, 68.0 | 68.0 | | results | [Premium Preview Result \[\]](connect_responses_premium_preview_result.htm "Output representation of the rolled-up premium amounts or per-node errors for one policy-hierarchy node.") | Per-node computed results in request order. When the references parameter is omitted or empty, this list contains a single entry for the policy root. All premium amounts are shown in this list. The response doesn’t include top-level total fields. | Small, 68.0 | 68.0 | # Premium Preview Result Output representation of the rolled-up premium amounts or per-node errors for one policy-hierarchy node. ## JSON Example { "recordId": "0YTxx000000004rGAA", "errors": \[\], "name": "Draft State Premium Dummy Policy -1", "amounts": { "standardPremium": 2164, "standardFee": 25, "standardTax": 15, "standardCommission": 0, "totalStandard": 2204, "termPremium": 2164, "termFee": 25, "termTax": 15, "termCommission": 0, "totalTerm": 2204 } } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | amounts | [Premium Preview Amounts](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_premium_preview_amounts.htm "Contains the ten rolled-up Standard and Term premium amount fields returned for a single policy-hierarchy node during a draft-state premium preview.") | Rolled-up standard and term premium amounts for this hierarchy node. Shows null when the node fails and errors are returned instead. | Small, 68.0 | 68.0 | | errors | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_responses_error_response.htm "HTML (New Window)")\[\] | Per-node errors for this reference, such as INVALID\_API\_INPUT when the record isn’t in the policy hierarchy or INSUFFICIENT\_ACCESS. Null when the node computed successfully. A per-node error doesn’t fail the entire request. | Small, 68.0 | 68.0 | | name | String | Name of the policy for which the premium amount is calculated. | Small, 68.0 | 68.0 | | recordId | String | ID of the policy-hierarchy node these amounts (or errors) belong to. Matches the requested reference, or the policy root whenreferences is omitted. | Small, 68.0 | 68.0 | # Preview Policy Premium (POST) Preview prorated and rolled-up premium amounts for draft insurance policy hierarchy without creating or updating the changes. Use this resource when you want to preview the premium on a policy or any child objects before issuing the policy. The API prorates and rolls up amounts in memory for the requested hierarchy nodes and returns the results. It doesn’t write roll-up fields, create insurance policy transactions, or trigger billing. Omit references to preview premium amounts only for the root policy. This API supports up to 2000 reference record IDs. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/premium-preview ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx000000004rGAA/premium-preview ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the insurance policy to preview premiums for. The key prefix is 0YT. | Required | 68.0 | ## Request Body for POST ### JSON Example { "references": { "references": \[ { "recordId": "0cYxx00000000ODEAY" }, { "recordId": "0cYxx00000000MbEAI" } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | references | [Premium Preview Reference Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_premium_preview_reference.htm "Input representation of a node within the insurance policy hierarchy whose rolled-up premium amounts you want to compute.")\[\] | List of hierarchy-node references to compute. If omitted or empty, the API returns only the root policy level amounts. Supports up to 2000 node references. Results are returned in the same order as this list. | Optional | 68.0 | ## Response Body for POST [Premium Preview Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_premium_preview.htm "Output representation of the details of the draft-state premium preview results for an insurance policy, including per-node rolled-up amounts and any errors.") # Preview Policy Premium Action Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/previewPolicyPremium Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | previewPolicyPremiumInputRepresentation | Apex-defined | Required. An Apex ConnectApi.PreviewPolicyPremiumIAInputRep record that contains the details to calculate and preview the premium amounts for the specified policy ID. | ## Outputs | Output | Type | Description | | --- | --- | --- | | previewPolicyPremiumOutputRepresentation | Apex-defined | An Apex ConnectApi\_\_PreviewPolicyPremiumIAOutputRep record that contains the policy premium details for preview. | ## Example **POST** This sample request is for the Preview Policy Premium action when references isn't specified. { "inputs": \[ { "previewPolicyPremiumInputRepresentation": { "insurancePolicyId": "0YTxx00000000CvGAI" } } \] } This sample response is for the Preview Policy Premium action when references isn't specified in the request. \[ { "actionName": "previewPolicyPremium", "errors": null, "expectedError": false, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "previewPolicyPremiumOutputRepresentation": { "policyId": "0YTfiP000000FdNGBU", "results": \[ { "amounts": { "standardCommission": 0, "standardFee": 0, "standardPremium": 3000, "standardTax": 0, "termCommission": 0, "termFee": 0, "termPremium": 3000, "termTax": 0, "totalStandard": 3000, "totalTerm": 3000 }, "errors": \[\], "name": "Draft State Premium Dummy Policy -1", "recordId": "0YTfiP000000FdNGBU" } \] } }, "sortOrder": -1, "version": 1 } \] This sample request is for the Preview Policy Premium action with references included in the request. { "inputs": \[ { "previewPolicyPremiumInputRepresentation": { "insurancePolicyId": "0YTfiP000000FdNGBU", "references": { "references": \[ { "recordId": "0YTfiP000000FdNGBU" } \] } } } \] } This sample response is for the Preview Policy Premium action when references is specified in the request. \[ { "actionName": "previewPolicyPremium", "errors": null, "expectedError": false, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "previewPolicyPremiumOutputRepresentation": { "policyId": "0YTfiP000000FdNGBU", "results": \[ { "amounts": { "standardCommission": 0, "standardFee": 0, "standardPremium": 3000, "standardTax": 0, "termCommission": 0, "termFee": 0, "termPremium": 3000, "termTax": 0, "totalStandard": 3000, "totalTerm": 3000 }, "errors": \[\], "name": "Draft State Premium Dummy Policy -1", "recordId": "0YTfiP000000FdNGBU" } \] } }, "sortOrder": -1, "version": 1 } \] # previewPolicyPremium(premiumPreviewInput, policyId) Preview prorated and rolled-up premium amounts across a draft insurance policy hierarchy without creating or updating changes. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.PremiumPreviewRepresentation previewPolicyPremium(ConnectApi.PremiumPreviewInputRep premiumPreviewInput, String policyId) ## Parameters premiumPreviewInput Type: [ConnectApi.PremiumPreviewInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_premium_preview_input_rep.htm "Input representation for a draft-state premium preview. Specify hierarchy-node references to compute, or leave the list empty to return only the policy-root amounts.") Input representation of hierarchy-node references to compute. Omit or leave references empty to get only the policy-root amounts. policyId Type: String ID of the insurance policy (prefix 0YT) to preview premiums for. ## Return Value Type: [ConnectApi.PremiumPreviewRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_premium_preview.htm "Output representation of a draft-state premium preview, including the policy ID and per-node rolled-up amount results.") ## Usage Use this method when a brokerage sales or service workflow needs to preview rolled-up policy amounts for a Draft insurance policy before issue. Unlike committed lifecycle events such as issue, endorse, cancel, and renew, this method performs a read-only, in-memory calculation. It fetches the policy hierarchy, prorates and rolls up amounts, and returns the calculated amounts without updating roll-up fields, creating IPT or IPTD line items, or triggering billing. Call this method from Apex or LWC in the same org to make an in-process Connect API call without HTTP session or remote-site configuration. For same-org automation, use this method instead of making an HTTP callout to the REST-based premium-preview resource. Keep these behaviors in mind. - **Whole-policy preview:** Pass an empty PremiumPreviewInputRep, or leave the references parameter null or empty to preview the entire policy. The response contains one entry for the policy root. - **Per-node preview:** Provide up to 2,000 hierarchy-node IDs for policies, assets, participants, coverages, or surcharges. Results are returned in the same order as the requested references. Specify only the nodes you need to keep large-policy previews configurable. - **Amounts:** Each successful result includes ten double fields on amounts, covering standard and term premium, fee, tax, commission, and totals. The response doesn't include top-level total fields; read amounts from results. For surcharge nodes, only totalStandard and totalTerm may be returned. - **Per-node failures:** A reference record that isn’t in the hierarchy returns INVALID\_API\_INPUT on that result’s errors list. Other nodes still compute, and the method returns normally. - **Request-level failures:** Conditions such as a disabled feature gate, invalid policyId, or more than 2000 references show ConnectApi.ConnectApiException. Wrap the call in try/catch when input isn’t trusted. - **Calculation Parity:** For identical inputs, the returned amounts are intended to match what policy issue computes for the same node, so quoted and issued figures stay aligned. ## Example These Apex examples show how to call ConnectApi.InsuranceBrokerageFamily.previewPolicyPremium(). **Whole-policy preview (no references)** Do not specify references so the API response returns a single policy-root entry in results. Id policyId = '0YTxx000000004rGAA'; // Empty input ⇒ policy-level (root) amounts only. ConnectApi.PremiumPreviewInputRep input = new ConnectApi.PremiumPreviewInputRep(); ConnectApi.PremiumPreviewRepresentation resp = ConnectApi.InsuranceBrokerageFamily.previewPolicyPremium(input, policyId); // results.size() == 1; the single entry is the policy root. ConnectApi.PremiumPreviewResultRepresentation root = resp.results\[0\]; System.assertEquals(policyId, root.recordId); System.debug('totalStandard = ' + root.amounts.totalStandard); // e.g. 2204 System.debug('totalTerm = ' + root.amounts.totalTerm); // e.g. 2164 **Specific hierarchy nodes** Pass references to return one result per node, in request order. Id policyId = '0YTxx000000004rGAA'; ConnectApi.PremiumPreviewReferenceRep a1 = new ConnectApi.PremiumPreviewReferenceRep(); a1.recordId = '0YWxx00000000CvGAI'; // Asset A1 ConnectApi.PremiumPreviewReferenceRep p1 = new ConnectApi.PremiumPreviewReferenceRep(); p1.recordId = '0aoxx000000004rAAA'; // Participant P1 ConnectApi.PremiumPreviewInputRep input = new ConnectApi.PremiumPreviewInputRep(); input.references = new List{ a1, p1 }; ConnectApi.PremiumPreviewRepresentation resp = ConnectApi.InsuranceBrokerageFamily.previewPolicyPremium(input, policyId); // results\[0\] ⇒ A1, results\[1\] ⇒ P1 for (ConnectApi.PremiumPreviewResultRepresentation r : resp.results) { if (r.errors == null) { System.debug(r.recordId + ' totalStandard=' + r.amounts.totalStandard); } else { System.debug(r.recordId + ' FAILED ' + r.errors\[0\].errorCode + ': ' + r.errors\[0\].message); } } **Per-node failure handling** A bad references fails only its own result; the method still returns a representation. Id policyId = '0YTxx000000004rGAA'; ConnectApi.PremiumPreviewReferenceRep bogus = new ConnectApi.PremiumPreviewReferenceRep(); bogus.recordId = '1OPxx0000004C93GAE'; // not a hierarchy node ConnectApi.PremiumPreviewInputRep input = new ConnectApi.PremiumPreviewInputRep(); input.references = new List{ bogus }; ConnectApi.PremiumPreviewRepresentation resp = ConnectApi.InsuranceBrokerageFamily.previewPolicyPremium(input, policyId); ConnectApi.PremiumPreviewResultRepresentation r = resp.results\[0\]; System.assertNotEquals(null, r.errors); // amounts == null, errors populated System.debug(r.errors\[0\].errorCode); // e.g. INVALID\_API\_INPUT # Price Comparison Attribute Details Output representation of the details of a single plan or coverage attribute, such as copay or coinsurance, that's returned with a price comparison node. Attributes are returned only when the request sets fetchAttributes to true. ## JSON Example { "name": "copay", "type": "Currency", "value": "$100" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | name | String | Name of the attribute, such as copay or coinsurance. | Small, 68.0 | 68.0 | | type | String | Data type of the attribute value, such as Currency or Percent. | Small, 68.0 | 68.0 | | value | String | Value of the attribute, formatted for display, such as $100 or 10%. | Small, 68.0 | 68.0 | # Price Comparison Currency Details Output representation of the details of the currency that all amounts in a price comparison are expressed in. Use these details to format the previous and current amounts for display. ## JSON Example { "locale": "en\_US", "name": "USD", "symbol": "$" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | locale | String | Locale to use when you format the amounts, such as en\_US. | Small, 68.0 | 68.0 | | name | String | ISO code of the currency, such as USD. | Small, 68.0 | 68.0 | | symbol | String | Symbol of the currency, such as $. | Small, 68.0 | 68.0 | # Price Comparison Duration Details Output representation of the details of a rating period that the comparison amounts apply to. Match the key value with the durationKey value of a comparison item to find the period that the item's amounts cover. ## JSON Example { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | effectiveFrom | String | Date when the rating period starts, in YYYY-MM-DD format. | Small, 68.0 | 68.0 | | effectiveTo | String | Date when the rating period ends, in YYYY-MM-DD format. | Small, 68.0 | 68.0 | | key | String | Unique key of the rating period. Comparison items refer to this key through their durationKey property. | Small, 68.0 | 68.0 | # Price Comparison Impact Details Output representation of the priced amounts for one side of a comparison. Each comparison item returns this representation twice, once as the previous amounts and once as the current amounts, so that you can show the price impact of the change. ## JSON Example { "attributes": \[ { "name": "copay", "type": "Currency", "value": "$100" }, { "name": "coinsurance", "type": "Percent", "value": "10%" } \], "fee": 20.00, "id": "0rHxx000000001aEAA", "premium": 2000.00, "tax": 180.00, "total": 2200.00 } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | [Price Comparison Attribute Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_attribute.htm "Output representation of the details of a single plan or coverage attribute, such as copay or coinsurance, that's returned with a price comparison node. Attributes are returned only when the request sets fetchAttributes to true.")\[\] | List of the plan or coverage attributes, such as copay and coinsurance, that apply to this side of the comparison. The list is populated only when the request sets fetchAttributes to true. | Small, 68.0 | 68.0 | | fee | Double | Rolled-up fee amount for this node. | Small, 68.0 | 68.0 | | id | String | ID of the priced record, such as the group census member plan, that this side of the comparison was calculated from. Use this ID to correlate the amounts with the underlying record. | Small, 68.0 | 68.0 | | premium | Double | Premium amount for this node, before taxes and fees. | Small, 68.0 | 68.0 | | tax | Double | Rolled-up tax amount for this node. | Small, 68.0 | 68.0 | | total | Double | Total of all the charges for this node, including the premium, taxes, and fees. | Small, 68.0 | 68.0 | # Price Comparison Item Details Output representation of the details of a single node in the price comparison, such as the overall summary, a plan, a group class, a member, or a coverage. The comparison is returned as a flat list of items. Build the hierarchy by matching the parent value of an item with the id value of another item. ## JSON Example { "category": "vision", "current": { "attributes": \[\], "fee": 40.00, "id": "0rHxx000000002bEAA", "premium": 2000.00, "tax": 180.00, "total": 2220.00 }, "durationKey": "dur1", "id": "identifier2", "name": "Vision Gold", "node": "plan", "parent": null, "previous": { "attributes": \[\], "fee": 20.00, "id": "0rHxx000000001aEAA", "premium": 1800.00, "tax": 180.00, "total": 2000.00 } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | category | String | Product category that the item belongs to, such as dental or vision. The value is null for the overall summary item. | Small, 68.0 | 68.0 | | current | [Price Comparison Impact Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_impact.htm "Output representation of the priced amounts for one side of a comparison. Each comparison item returns this representation twice, once as the previous amounts and once as the current amounts, so that you can show the price impact of the change.") | New amounts for the item, after the change that's being analyzed. | Small, 68.0 | 68.0 | | durationKey | String | Key of the rating period that the item's amounts apply to. The key matches the key value of an entry in the durations list. | Small, 68.0 | 68.0 | | id | String | Identifier of the item within the response. Child items refer to this value through their parent property. | Small, 68.0 | 68.0 | | name | String | Display name of the item, such as the plan name, group class name, coverage name, or member name. The value is null for the overall summary item. | Small, 68.0 | 68.0 | | node | String | Type of the element that the item represents. Valid values are summary, plan, class, member, and coverage. | Small, 68.0 | 68.0 | | parent | String | Identifier of the parent item in the comparison hierarchy. The value is null for the top-level items, such as the overall summary and the plans. | Small, 68.0 | 68.0 | | previous | [Price Comparison Impact Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_impact.htm "Output representation of the priced amounts for one side of a comparison. Each comparison item returns this representation twice, once as the previous amounts and once as the current amounts, so that you can show the price impact of the change.") | Old amounts for the item, before the change that's being analyzed. The amounts are zero for a fresh enrollment, where no earlier price exists. | Small, 68.0 | 68.0 | # Price Comparison Response Output representation of the price impact that's calculated for a group census. The response includes the available product categories, the event summary, the rating periods, the currency, and a flat list of comparison items that carry the previous and current amounts for each plan, group class, member, and coverage. ## JSON Example This JSON sample shows a response with price comparison details when fetchAttributes is set to false by default. { "categories": { "dental": "Dental", "vision": "Vision" }, "comparisons": \[ { "category": null, "current": { "attributes": \[\], "fee": 400.00, "id": "0rHxx000000001aEAA", "premium": 2000.00, "tax": 180.00, "total": 2580.00 }, "durationKey": "dur1", "id": "identifier1", "name": null, "node": "summary", "parent": null, "previous": { "attributes": \[\], "fee": 200.00, "id": "0rHxx000000002bEAA", "premium": 1800.00, "tax": 180.00, "total": 2180.00 } }, { "category": "vision", "current": { "attributes": \[\], "fee": 40.00, "id": "0rHxx000000003cEAA", "premium": 2000.00, "tax": 180.00, "total": 2220.00 }, "durationKey": "dur1", "id": "identifier2", "name": "Vision Gold", "node": "plan", "parent": null, "previous": { "attributes": \[\], "fee": 20.00, "id": "0rHxx000000004dEAA", "premium": 1800.00, "tax": 180.00, "total": 2000.00 } } \], "currencyInfo": { "locale": "en\_US", "name": "USD", "symbol": "$" }, "durations": \[ { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } \], "errors": \[\], "isSuccess": true, "summary": { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } } This JSON sample shows a response with attribute comparison details when fetchAttributes is set to true. { "categories": { "dental": "Dental", "vision": "Vision" }, "comparisons": \[ { "current": { "attributes": \[\], "id": "0rHxx000000001aEAA" }, "durationKey": "dur1", "id": "identifier1", "node": "summary", "previous": { "id": "0rIxx000000001bEAA", "attributes": \[ { "name": "copay", "value": "100", "type": "Currency" }, { "name": "coinsurance", "value": "10", "type": "Percent" } \] } }, { "category": "vision", "current": { "attributes": \[\], "id": "0rHxx000000003cEAA" }, "durationKey": "dur1", "id": "identifier2", "name": "Vision Gold", "node": "plan", "previous": { "id": "0rIxx000000003dEAA", "attributes": \[ { "name": "copay", "value": "100", "type": "Currency" }, { "name": "coinsurance", "value": "10", "type": "Percent" } \] } } \], "currencyInfo": { "locale": "en\_US", "name": "USD", "symbol": "$" }, "durations": \[ { "effectiveFrom": "2026-01-01", "effectiveTo": "2026-12-31", "key": "dur1" } \], "errors": \[\], "isSuccess": true, "summary": { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | categories | Map | Map of the product categories that are available for the group census, where the key is the category ID and the value is the category label. Pass a key from this map as the category property of a later request to filter the comparison. | Small, 68.0 | 68.0 | | comparisons | [Price Comparison Item Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item.htm "Output representation of the details of a single node in the price comparison, such as the overall summary, a plan, a group class, a member, or a coverage. The comparison is returned as a flat list of items. Build the hierarchy by matching the parent value of an item with the id value of another item.")\[\] | Flat list of the comparison items for the group census. Each item carries the previous and current amounts for a node in the hierarchy, such as the overall summary, a plan, a group class, a member, or a coverage. | Small, 68.0 | 68.0 | | currencyInfo | [Price Comparison Currency Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_currency.htm "Output representation of the details of the currency that all amounts in a price comparison are expressed in. Use these details to format the previous and current amounts for display.") | Currency in which all the amounts in the response are expressed. All the amounts use the org currency. | Small, 68.0 | 68.0 | | durations | [Price Comparison Duration Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item_duration.htm "Output representation of the details of a rating period that the comparison amounts apply to. Match the key value with the durationKey value of a comparison item to find the period that the item's amounts cover.")\[\] | List of the rating periods that the comparison covers. Comparison items refer to these periods through their durationKey property. | Small, 68.0 | 68.0 | | errors | [Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of the errors that occurred while the price comparison was calculated. The list is empty when isSuccess is true. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the price comparison is calculated successfully (true) or not (false). | Small, 68.0 | 68.0 | | summary | [Price Comparison Summary Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_summary.htm "Output representation of the counts of the membership events in the group census that contribute to the price change, such as hires, endorsements, and terminations. Use these counts to explain why the price moved between the previous and the current amounts.") | Counts of the membership events in the group census, such as hires, endorsements, and terminations, that contribute to the price change. | Small, 68.0 | 68.0 | # Price Comparison Summary Details Output representation of the counts of the membership events in the group census that contribute to the price change, such as hires, endorsements, and terminations. Use these counts to explain why the price moved between the previous and the current amounts. ## JSON Example { "endorse": 10, "enrollment": 0, "hire": 20, "terminate": 10 } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | endorse | Integer | Number of members whose coverage is endorsed, or changed mid-term, in the group census. | Small, 68.0 | 68.0 | | enrollment | Integer | Number of members who are enrolled in the group census. | Small, 68.0 | 68.0 | | hire | Integer | Number of members who are added to the group census as new hires. | Small, 68.0 | 68.0 | | terminate | Integer | Number of members whose coverage is terminated in the group census. | Small, 68.0 | 68.0 | # Process Member Enrollment Action Create insurance policies for specified group census members as per their selected plans. The action retrieves member-specific coverage selections, validates them against the plan selection and checks for duplicate policies if specified in action parameter, and generates insurance policies, coverages, participants and related objects. The action returns list of insurance policy IDs that are generated or error if they occur during the processing. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/processMemberEnrollment Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractGroupPlanId | string | Required ID of the Contract Group Plan that's used to retrieve associated product and coverage details. | | createRelatedObjectRecords | boolean | Indicates whether to create related records for each insurance policy participant ( true ) or not ( false ). If set to true , two insurance policy participant related object records are created per participant. The first record maps the participant to the associated Group Census Member, and the second record links the participant to either a Person Account or a Contact, based on their participant type. | | duplicateCheckRequired | boolean | Indicates whether to check for duplicate policies ( true ) or not ( false ). The default value is true . If set to true and a policy already exists for the same member and product category, this invocable action shows an error. | | groupCensusMembers | sobject | Collection of group census member records that represent the members that must be enrolled. | | pricingResult | Apex-defined | Collection of Apex ConnectApi.MembersPlansRatingOutput records that contain pricing results for the requested members. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insurancePolicyIds | string | IDs of the insurance policy records that are created. | ## Example Sample Request { "inputs": \[ { "groupCensusMembers": \[ { "Id": "0r6SG00000093MrYAI", "Name": "John Doe", "FirstName": "John", "LastName": "Doe", "Email": "john.doe@example.com", "BirthDate": "1998-03-15" } \], "contractGroupPlanId": "0rgSG0000000iaXYAQ", "pricingResult": { "pricingResults": \[ { "plans": \[ { "rates": \[ { "value": 60, "key": "NetUnitPrice" }, { "value": 0, "key": "StandardQLITaxAmount" } \], "proratedRates": \[ { "value": 60, "key": "NetUnitPrice" }, { "value": 0, "key": "StandardQLITaxAmount" } \], "planId": "0rgSG0000000iaXYAQ", "errors": \[\], "coverages": \[ { "rates": \[ { "value": 0, "key": "StandardQLITaxAmount" }, { "value": 20, "key": "NetUnitPrice" } \], "proratedRates": \[ { "value": 0, "key": "StandardQLITaxAmount" }, { "value": 20, "key": "NetUnitPrice" } \], "errors": \[\], "coverageId": "0rgSG0000000iaZYAQ", "contributions": { "groupClassContributionId": "0rFSG0000000Beb2AE", "errors": \[\], "employerPremiumAmount": 2, "employeePremiumAmount": 18 } }, { "rates": \[ { "value": 0, "key": "StandardQLITaxAmount" }, { "value": 40, "key": "NetUnitPrice" } \], "proratedRates": \[ { "value": 0, "key": "StandardQLITaxAmount" }, { "value": 40, "key": "NetUnitPrice" } \], "errors": \[\], "coverageId": "0rgSG0000000iaaYAA", "contributions": { "groupClassContributionId": null, "errors": \[\], "employerPremiumAmount": 0, "employeePremiumAmount": 40 } } \], "contributions": { "groupClassContributionId": null, "errors": \[\], "employerPremiumAmount": 2, "employeePremiumAmount": 58 } } \], "memberId": "0r6SG00000093MrYAI", "errors": \[\] } \], "errors": \[\] } } \] } Sample Response \[ { "actionName": "processMemberEnrollment", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insurancePolicyIds": \["0YTSG000000QzO14AK"\] }, "sortOrder": -1, "version": 1 } \] # Process Member Plans for Mid-Term Adjustment Action Apply mid-term adjustment changes for group insurance policies to group census member plans. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/procMbrPlansForMidTermAdj Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | censusMemberPlanData | Apex-defined | An Apex ind\_ins\_grpben\_\_GroupCensusMemberNode record that contains the group census member plan records, such as group census members, member plans, and plan attributes. | | groupCensusMemberPlans | List | Collection of group census member plan records. | | groupCensusMembers | List | Collection of group census member records. | ## Outputs | Output | Type | Description | | --- | --- | --- | | censusMemberPlanData | Apex-defined | An Apex ind\_ins\_grpben\_\_GroupCensusMemberNode record that contains the census member plan records, such as group census members, member plans, and plan attributes. | | errorsData | Apex-defined | An Apex ind\_ins\_grpben\_\_ErrorDetails record that contains the errors that are encountered during the process. | | groupCensusMemberPlans | List | Collection of group census member plan records. | | groupCensusMembers | List | Collection of group census member records. | ## Example **POST** This sample request is for the Process Member Plans for Mid-Term Adjustment action. { "inputs": \[ { "censusMemberPlanData": \[ { "member": { "EventType": "endorsement", "AssociationWithPrimaryMbr": "Self", "EventEffectiveDate": "2026-06-01", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "AccountId": "001XXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Add>Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001" }, "attributes": \[\] } \] }, { "member": { "AssociationWithPrimaryMbr": "Spouse", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "AccountId": "001XXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001" }, "attributes": \[\] } \] } \] } \] } This sample response is for the Process Member Plans for Mid-Term Adjustment action. \[ { "actionName": "procMbrPlansForMidTermAdj", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "censusMemberPlanData": \[ { "member": { "EventType": "endorsement", "AssociationWithPrimaryMbr": "Self", "EventEffectiveDate": "2026-06-01", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "AccountId": "001XXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001", "EventAction": "Add" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001", "EventAction": "Add" }, "attributes": \[\] } \] }, { "member": { "AssociationWithPrimaryMbr": "Spouse", "GroupCensusId": "0rfXXXXXXXXXXXXAAA", "AccountId": "001XXXXXXXXXXXXAAA" }, "plans": \[ { "plan": { "PlanName": "Medical Gold", "ContractGroupPlanId": "a0bXXXXXXXXXXXX001", "EventAction": "Add" }, "attributes": \[\] }, { "plan": { "PlanName": "Preventive Care", "ContractGroupPlanId": "a0bXXXXXXXXXXXX002", "ContractGroupPlan.ContractGroupParentPlanId": "a0bXXXXXXXXXXXX001", "EventAction": "Add" }, "attributes": \[\] } \] } \], "errorsData": \[\] }, "sortOrder": -1, "version": 1 } \] # Process Policy Limits (POST) Process the policy limits for a loss item in a claim by using the current standings of the insurance policy limits. This API uses the default Expression Set Executable Template to evaluate how a specific transaction affects the monetary and non-monetary policy limits. You can either extend the executable template to create a custom Expression Set or invoke an Integration Procedure for more complex calculations. This API uses coverage and transaction details as input and returns a detailed breakdown of how each applicable limit is consumed by the proposed amount. ## Resource {claimId} and {coverageId} are placeholders. /connect/insurance/claims/{claimId}/coverages/{coverageId}/process-limits ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/claims/0Zkxx000000001dEAA/coverages/0kPxx000000002fEAA/process-limits ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | claimId | String | ID of the claim to process the policy limits for. | Required | 65.0 | | coverageId | String | ID of the claim coverage within the claim that the loss item belongs to. | Required | 65.0 | ## Request Body for POST ### JSON Example { "adjustedAmount": 1250.00, "benefitName": "Collision Coverage", "limitUnitCount": 1 "paymentDetailId": "0l2xx0000000001CAA" } ### Properties
Name Type Description Required or Optional Available Version
adjusted​Amount Double Amount after adjustments are made based on the current standings of the policy limits. Optional 65.0
benefitName String Name of the specific benefit or sub-coverage that the loss item applies to. Optional 65.0
limitUnit​Count Integer Unit count that the payment detail represents.

Default value is 1.

 Optional 65.0
paymentDetailId Integer ID of the claim coverage payment detail record that’s associated with the loss item. Optional 67.0
## Response Body for POST [Process Policy Limits Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_process_policy_limits.htm "Output representation for processing the policy limits for a claim loss item.") # Process Policy Limits Input Input representation for processing policy limits for a claim loss item. ## JSON Example { "adjustedAmount": 1250.00, "benefitName": "Collision Coverage", "limitUnitCount": 1 "paymentDetailId": "0l2xx0000000001CAA" } ## Properties
Name Type Description Required or Optional Available Version
adjusted​Amount Double Amount after adjustments are made based on the current standings of the policy limits. Optional 65.0
benefitName String Name of the specific benefit or sub-coverage that the loss item applies to. Optional 65.0
limitUnit​Count Integer Unit count that the payment detail represents.

Default value is 1.

 Optional 65.0
paymentDetailId Integer ID of the claim coverage payment detail record that’s associated with the loss item. Optional 67.0
# Process Policy Limits Response Output representation for processing the policy limits for a claim loss item. ## JSON Example { "isLimitExceeded": false, "insPolicyLimitTrackings": \[ { "policyLimitId": "0lYx00000004CvQEAU", "category": "Per-Incident Limit", "remainingAmount": 3750.00 } \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | Errors that are shown when the API operation fails. | Big, 65.0 | 65.0 | | exceededAmount | Double | Amount that exceeds the remaining available policy limit in the specified limit currency. | Big, 66.0 | 66.0 | | exceededCount | Integer | Count of coverage units beyond the policy’s allowed unit limit. | Big, 66.0 | 66.0 | | insPolicy​LimitTrackings | [Policy Limit Tracking Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_limit_tracking_details.htm "Output representation for the insurance policy limit tracking details.")\[\] | List of insurance policy limit tracking details. | Big, 65.0 | 65.0 | | isLimit​Exceeded | Boolean | Indicates whether a limit is exceeded (true) or not (false). | Big, 65.0 | 65.0 | # ProcessPolicyLimits(ProcessPolicyLimitsInput, claimId, coverageId) Process the policy limits for a loss item in a claim by using the current standings of the insurance policy limits. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.ProcessPolicyLimitsRepresentation ProcessPolicyLimits(ConnectApi.ProcessPolicyLimitsInputRepresentation ProcessPolicyLimitsInput, String claimId, String coverageId) ## Parameters **ProcessPolicyLimitsInput** - Type: [ConnectApi.ProcessPolicyLimitsInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_process_policy_limits.htm "Input representation for processing policy limits for a claim loss item.") - JSON object that contains details for processing the policy limits. **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage. ## Return Value Type: [ConnectApi.ProcessPolicyLimitsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_process_policy_limits.htm "Output representation for processing the policy limits for a claim loss item.") ## Example Here's an example of how to invoke the Process Policy Limits API by using Apex. public with sharing class PostApiCalloutProcessLimitTest implements System.Callable { public Object call(String action, Map args) { System.debug('>>> Action: ' + action); System.debug('>>> Args: ' + JSON.serializePretty(args)); Map bodyMap = new Map(); // Extract 'input' from args Map inputMap = (Map)args.get('input'); Map outputMap = (Map)args.get('output'); String claimId; String claimCoverageId; String CLAIM\_ID = 'claimId'; String CLAIM\_COVERAGE\_ID = 'claimCoverageId'; String ADJUSTED\_AMOUNT = 'adjustedAmount'; String LIMIT\_UNIT\_COUNT = 'limitUnitCount'; String BENEFIT\_NAME = 'benefitName'; if (inputMap != null) { if (inputMap.containsKey(ADJUSTED\_AMOUNT) && inputMap.get(ADJUSTED\_AMOUNT) != null) { bodyMap.put(ADJUSTED\_AMOUNT, String.valueOf(inputMap.get(ADJUSTED\_AMOUNT))); } if (inputMap.containsKey(LIMIT\_UNIT\_COUNT) && inputMap.get(LIMIT\_UNIT\_COUNT) != null) { bodyMap.put(LIMIT\_UNIT\_COUNT, String.valueOf(inputMap.get(LIMIT\_UNIT\_COUNT))); } if (inputMap.containsKey(BENEFIT\_NAME) && inputMap.get(BENEFIT\_NAME) != null) { bodyMap.put(BENEFIT\_NAME, String.valueOf(inputMap.get(BENEFIT\_NAME))); } if (inputMap.containsKey(CLAIM\_ID) && inputMap.get(CLAIM\_ID) != null) { claimId = String.valueOf(inputMap.get(CLAIM\_ID)); } if (inputMap.containsKey(CLAIM\_COVERAGE\_ID) && inputMap.get(CLAIM\_COVERAGE\_ID) != null) { claimCoverageId = String.valueOf(inputMap.get(CLAIM\_COVERAGE\_ID)); } } String jsonBody = JSON.serialize(bodyMap); System.debug('>>> Final JSON Body: ' + jsonBody); System.debug('>>> Claim Id : ' + claimId); System.debug('>>> Claim Coverage Id : ' + claimCoverageId); String str = postDataToExternalApi(jsonBody, claimId, claimCoverageId); return outputMap.put('response', str); } public static String postDataToExternalApi(String jsonBody, String claimId, String claimCoverageId) { HttpRequest request = new HttpRequest(); Http http = new Http(); // Endpoint for Process Limits String url = 'callout:invokeUW/services/data/v65.0/connect/insurance/' + 'claims/' + claimId + '/coverages/' + claimCoverageId + '/process-limits'; request.setEndpoint(url); request.setMethod('POST'); request.setHeader('Content-Type', 'application/json'); request.setTimeout(120000); // 2 mins timeout request.setBody(jsonBody); System.debug('>>> Calling Process Limits API'); System.debug('>>> Calling Endpoint : ' + url ); try { HttpResponse response = http.send(request); System.debug('>>> Status Code: ' + response.getStatusCode()); System.debug('>>> Response Body: ' + response.getBody()); return response.getBody(); } catch (Exception e) { System.debug('Exception: ' + e.getMessage()); return 'Exception: ' + e.getMessage(); } } } # Product Output representation of product details. ## JSON Example This example shows a sample success response. "benefits": \[ { "id": "01tSG0000011y9dYAA", "name": "Annual deductible/Individual", "componentGroupId": "0y7SG0000000Q8zYAE", "componentGroupName": "General plan information", "componentGroupSequence": 1, #optional "sequence": 1, #optional "attributes": \[ { "id": "0tjSG0000001embYAA", "sequence": 1, #optional "name": "Copay", "label": "Copay Currency", #optional "dataType": "CURRENCY", "keyHidden":false, "isActive": true }, { "id": "0tjSG0000001eoDYAQ", "sequence": 1, "name": "Coinsurance", "label": "Coinsurance Percentage", "dataType": "PERCENTAGE", "keyHidden":false, "isActive": true } \] } \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | attributes | [Attribute Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_attribute_detail.htm "Output representation of product attribute details.")\[\] | List of attributes. | Small, 63.0 | 63.0 | | componentGroupId | String | ID of the component group. | Small, 63.0 | 63.0 | | componentGroupName | String | Name of the component group. | Small, 63.0 | 63.0 | | componentGroupSequence | Integer | Sequence of the component group. | Small, 63.0 | 63.0 | | id | String | ID of the product. | Small, 63.0 | 63.0 | | name | String | Name of the product. | Small, 63.0 | 63.0 | | sequence | Integer | Sequence of the product. | Small, 63.0 | 63.0 | # Product Clause Creation Details Output representation for the bulk creation of product clauses. ## JSON Example { "isSuccess": true, "productClauses": \[ { "productClauseId": "0j4xx0000000001AAA", "apiName": "AutoGlassClause\_2025" } \], "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Product Clause Error\[\]](connect_responses_insurance_product_clause_error.htm "Output representation of an error that occurred during the product clause operation.") | List of errors that occurred during processing. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the bulk creation operation is successful (true) or not (false). | Big, 65.0 | 65.0 | | productClauses | [Product Clauses \[\]](connect_responses_insurance_create_product_clause_output.htm "Output representation for a successfully created product clause.") | List of product clauses that are successfully created. | Big, 65.0 | 65.0 | # Product Clause Error Output representation of an error that occurred during the product clause operation. ## JSON Example { "code": "DUPLICATE\_API\_NAME", "message": "A product clause with this API name already exists." } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Error code that identifies the type of error. | Big, 65.0 | 65.0 | | message | String | Message that describes the error. | Big, 65.0 | 65.0 | # Product Clause Generation Details Output representation of the details for a clause generation request. ## JSON Example { "success": true, "asyncBulkRequestId": "750xx0000000001AAA", "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | asyncBulk​RequestId | String | Asynchronous bulk request ID for tracking the clause generation process. | Big, 65.0 | 65.0 | | errors | [Product Clause Error\[\]](connect_responses_insurance_product_clause_error.htm "Output representation of an error that occurred during the product clause operation.") | List of errors that occurred during processing. | Big, 65.0 | 65.0 | | success | Boolean | Indicates whether the operation is successful (true) or not (false). | Big, 65.0 | 65.0 | # Product Clause Generation Input Input representation for generating product clauses. ## JSON Example { "quoteId": "0Q0xx0000000001AAA", "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59", "quoteLineItemIds": \[ "0QLxx0000000003CCC" \], "instanceKeys": \[ { "instanceKey": \[ "Auto", "Liability" \] } \], "options": { "generateClausesAsync": true, "generateManualClauses": false, "saveContext": true } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the context based on which the product clause is generated. | Required if quoteId isn't specified | 65.0 | | instanceKeys | [Instance Key Input\[\]](connect_requests_instance_key_input.htm "Input representation for a single instance key array.") | List of instance keys. | Optional | 65.0 | | options | [Clause Generation Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_clause_generation_options_input.htm "Input representation for clause generation options.") | Options for clause generation. | Optional | 65.0 | | quoteId | String | ID of the quote. | Required if contextId isn't specified | 65.0 | | quote​LineItem​Ids | String\[\] | IDs of the quote line items. | Optional | 65.0 | # Product Clause Input Input representation for the details of a single product clause to be created. ## JSON Example { "apiName": "DeductibleWaiver\_2025", "name": "Deductible Waiver Clause", "effectiveDate": "2025-01-01", "expirationDate": "2025-12-31", "insuranceClauseId": "0j1xx0000000004DDD", "rootProduct": "01t000000003CCC", "productPath": "01t000000003DDD", "variableMappings": \[ { "variable": "DeductibleAmount", "variableType": "Currency", "attribute": "WaiverAmount" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the product clause. | Required | 65.0 | | effectiveDate | String | Date from which the clause is valid. | Required | 65.0 | | expirationDate | String | Date from which the clause is no longer valid. | Required | 65.0 | | insurance​ClauseId | String | Insurance clause component that's associated with the product clause. | Required | 65.0 | | name | String | Name of the product clause. | Required | 65.0 | | productPath | String | Product path of the product clause. | Required | 65.0 | | productRelated​ComponentId | String | Product-related component that's associated with the product clause. | Optional | 65.0 | | rootProduct | String | Root product of the product clause. | Required | 65.0 | | variable​Mappings | [Product Clause Variable Mapping Input\[\]](connect_requests_insurance_product_clause_variable_mapping_input.htm "Input representation for mapping an insurance clause variable to an insurance product variable.") | List of variable mappings for the product clause. | Optional | 65.0 | # Product Clause Update Details Output representation of the details for an updated product clause. ## JSON Example { "isSuccess": true, "productClauseId": "0j4xx0000000001AAA", "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Product Clause Error\[\]](connect_responses_insurance_product_clause_error.htm "Output representation of an error that occurred during the product clause operation.") | List of errors that occurred during processing. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the update operation is successful (true) or not (false). | Big, 65.0 | 65.0 | | productClauseId | String | ID of the product clause that's updated. | Big, 65.0 | 65.0 | # Product Clause Update Input Input representation for updating a product clause. ## JSON Example { "effectiveDate": "2026-01-01", "expirationDate": "2026-12-31", "variableMappings": \[ { "id": "a1Bxx0000000001AAA", "variable": "LimitAmount", "attribute": "NewCoverageLimit" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveDate | String | Date from which the product clause is valid. | Optional | 65.0 | | expirationDate | String | Date from which the product clause is no longer valid. | Optional | 65.0 | | variable​Mappings | [Product Clause Variable Mapping Input\[\]](connect_requests_insurance_product_clause_variable_mapping_input.htm "Input representation for mapping an insurance clause variable to an insurance product variable.") | Variable mappings for the product clause that must be updated. | Optional | 65.0 | # Product Clause Variable Mapping Input Input representation for mapping an insurance clause variable to an insurance product variable. ## JSON Example { "id": "a1Bxx0000000001AAA", "variable": "LimitAmount", "variableType": "Currency", "attribute": "CoverageLimit" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attribute | String | Attribute that's mapped to the variable of the Insurance Product Clause record. | Optional | 65.0 | | id | String | ID of the Insurance Product Clause Variable Mapping record. | Optional | 65.0 | | variable | String | Variable that's associated with the Insurance Product Clause record. | Required | 65.0 | | variableType | String | Type of the variable that's associated with the attribute. | Optional | 65.0 | # Product Clauses Output representation for a successfully created product clause. ## JSON Example { "productClauseId": "0j4xx0000000001AAA", "apiName": "AutoGlassClause\_2025" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | apiName | String | API name of the product clause that's created. | Big, 65.0 | 65.0 | | productClauseId | String | ID of the product clause that's created. | Big, 65.0 | 65.0 | # Product Rating Details Response Output representation that contains the constructed rating request payload. ## JSON Example { "salesTransactionTypeId": "0YWxx000000001GAAQ", "transactionType": "NewBusiness", "ratingInputs": \[ { "instanceKeys": \[ "autoSilver", "auto", "comprehensive" \], "productCode": "comprehensive", "attributes": { "NumberOfDays": "", "Deductible": "100", "BodilyInjuryPerPersonLimit": "", "PropertyDamagePerAccidentLimit": "", "Limit": "1000", "BodilyInjuryPerAccidentLimit": "" }, "additionalFields": {} } \], "ratingOptions": { "executeConfigurationRules": true, "executePricing": true, "returnContextJSON": false, "returnProductDetails": false }, "effectiveDate": "2025-01-01T00:00:00.000Z", "ratingDate": "2025-01-01T00:00:00.000Z", "additionalFields": { "customField1": "value1" }, "rootProductCodes": \[ "AUTO\_POLICY" \] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Additional custom fields that are used to generate rating request payload. | Big, 66.0 | 66.0 | | effectiveDate | Date | Date that's used to find the active pricing procedure for pricing. The default value is the current date. | Big, 66.0 | 66.0 | | ratingDate | Date | Date that's used to calculate rating. | Big, 66.0 | 66.0 | | ratingInputs | [Rating Input Node Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_input_node_output.htm "Output representation of a single node in the rating input hierarchy.")\[\] | List of the rating input nodes in the hierarchical structure that contains the attribute values of each context node. | Big, 66.0 | 66.0 | | ratingOptions | [Rating Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_options_output.htm "Output representation of the rating options that are returned in the response.") | Rating options that are used to control the rating behavior for the Insurance Product Rating API. | Big, 66.0 | 66.0 | | rootProductCodes | String\[\] | Root product codes that the products belong to for which the rating request payload is created. | Big, 66.0 | 66.0 | | salesTransaction​TypeId | String | ID of the sales transaction type. | Big, 66.0 | 66.0 | | transactionType | String | Name of the transaction processing type. | Big, 66.0 | 66.0 | # Product Rating Patch Input Input representation of product rating update details. ## JSON Example { "contextId": "a49103b233638b918217c74eced69220e534e160c3d3d35bc8cf6608515aeab3", "ratingOptions": { "executePricing": true, "executeConfigurationRules": false }, "updatedNodes": \[ { "instanceKeys": \[ "AutoSilver", "BMW", "Tim1" \], "productCode": "driver", "attributes": { "DriverAccidentPoints": 1, "AgeFirstLicensed": 50, "DriverMVRPoints": 1 }, "targetRecords": \[ "003DR000002ov8NYAQ", "001DR000003avQCYAY" \] } \], "addedNodes": \[ { "instanceKeys": \[ "AutoSilver", "Tesla" \], "productCode": "auto", "attributes": { "Year": "2022", "Model": "Y" } }, { "instanceKeys": \[ "AutoSilver", "Tesla", "collision1" \], "productCode": "collision", "attributes": { "Limit": 500, "Deductible": 1000 } }, { "instanceKeys": \[ "AutoSilver", "Tesla", "Driver1" \], "productCode": "driver", "attributes": { "DriverAccidentPoints": 5, "AgeFirstLicensed": 30, "DriverMVRPoints": 1 }, "targetRecords": \[ "003DR000002oxCfYAI", "001DR000003azdpYAA" \] }, { "instanceKeys": \[ "AutoSilver", "Audi", "Collision2" \], "productCode": "collision", "attributes": { "Limit": 500, "Deductible": 1000 } } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | addedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of added nodes. | Optional | 63.0 | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Optional | 63.0 | | contextId | String | Context ID. | Required | 63.0 | | deletedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of deleted nodes. | Optional | 63.0 | | effectiveDate | String | Date used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 63.0 | | ratingDate | String | Date that's used to find the active pricing procedure. | Optional | 63.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.")\[\] | Options for rating. | Optional | 63.0 | | updatedNodes | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | List of updated nodes. | Optional | 63.0 | # Product Rating Post Input Input representation of the product rating details. ## JSON Example { "transactionType": "AutoTransactionType", "additionalFields": { "QuoteAccount": "001ZM000002ZNnBYAW" }, "ratingOptions": { "executeConfigurationRules": false }, "ratingInputs": \[ { "productCode": "auto", "instanceKeys": \[ "Auto1" \], "attributes": { "Make": "BMW", "AutoValue": "20000", "Year": "2024", "Model": "SUV" } }, { "productCode": "comprehensive", "instanceKeys": \[ "Auto1", "Comprehensive" \], "attributes": { "Limit": "2000", "Deductible": "100" } } \], "rootProductCodes": \[ "auto-ECO1x", "auto-ECO2x" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Required if the generated context ID is used to issue a policy | 63.0 | | effectiveDate | String | Date used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 63.0 | | ratingInputs | [Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm "Input representation of details of context node.")\[\] | JSON that contains the attribute values of each context node. | Required | 63.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.")\[\] | Options for rating. | Optional | 63.0 | | rootProductCodes | String \[\] | Root product codes that are used with the ratingInputs to create rating result. The created rating result is used as request in the insurance product rating API. | Optional | 66.0 | | transactionType | String | Name of the transaction processing type. | Required | 63.0 | # Product Rating Request Input Input representation for getting rating input from product IDs. ## JSON Example { "productIds": \[ "01txx0000006i3DAAQ" \], "salesTransactionTypeId": "0YWxx000000001GAAQ", "transactionType": "Auto", "ratingOptions": { "executeConfigurationRules": true, "executePricing": true, "returnContextJSON": false, "returnProductDetails": false }, "effectiveDate": "2025-01-01T00:00:00.000Z", "ratingDate": "2025-01-01T00:00:00.000Z", "additionalFields": { "customField1": "value1" }, "rootProductCodes": \[ "AUTO\_POLICY" \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Additional fields to generate rating input. | Optional | 66.0 | | effectiveDate | Date | Date that's used to find the active pricing procedure for pricing. The default value is the current date. | Optional | 66.0 | | productIds | String\[\] | IDs of the products for which you want to generate rating input. | Required | 66.0 | | ratingDate | Date | Date that's used to calculate rating. | Optional | 66.0 | | ratingOptions | [Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm "Input representation details of rating service options.") | Options to control rating behavior. | Optional | 66.0 | | rootProduct​Codes | String\[\] | Root product codes that are used to create rating inputs. | Optional | 66.0 | | salesTransaction​TypeId | String | ID of the sales transaction type for which you want to generate rating request payload. | Optional | 66.0 | | transaction​Type | String | Name of the transaction processing type. | Optional | 66.0 | # Product Rating Response Output representation for the Product Rating Connect API. ## JSON Example This example shows a sample success response. { "contextId": "11jxx0000006i5gAAA", "pricingResult": { "Economy Renter 1": { "NetUnitPrice": 1000, "childNodes": \[\] }, "Economy Renter 2": { "NetUnitPrice": 2000, "childNodes": \[\] } }, "contextJSON": { "SalesTransaction": \[ { "Account": null, "businessObjectType": "Quote", "SalesTransactionName": "Test Quote", "ProratedAmount": 112.25, "StartDate": "2025-07-01", "CurrencyIsoCode\_\_std": "USD", "InsuranceQuoteType": "New Business", "TransactionType": "AutoTransactionType", "TotalProratedAmount": 132.25, "Pricebook": "01sSG000009SJvNYAW", "Opportunity": null, "TotalAmount": 277.15, "EndDate": "2025-08-31", "SalesTransactionItem": \[ { "businessObjectType": "QuoteLineItem", "Product": "01tSG000008KnvSYAS", "id": "0QLSG000000dIxz4AE", "ProductCode": "Auto Silver", "SalesTransactionItemAttribute": \[ { "AttributeKey": "0tjSG0000006q8GYAQ", "AttributeValue": "6.0", "ParentReference": "0QLSG000000dIxy4AE", "hasObjectRef": null, "AttributePicklistValue": null, "IsPriceImpacting": null, "businessObjectType": "QuoteLineItemAttribute", "AttributeName": "Driver MVR Points", "id": "0zuSG000002IfoSYAS", "AttributeDefinitionCode": "DriverMVRPoints", "SalesTransactionItemAttrParent": "0QLSG000000dIxy4AE", "AttributeDeveloperName": "Driver\_MVR\_Points" } \], "LineItemPath": "0QLSG000000dIy04AE/0QLSG000000dIxz4AE", "PricebookEntry": "01uSG000003chfXYAQ", "NetUnitPrice": 79.77, "ParentReference": "0Q0SG000000P3XN0A0", "UnitPrice": 469.6, "InstanceKey": "673ec36c-7d4a-4e8a-999a-6cf16a299f4a", "childNodes": \[ { "businessObjectType": "QuoteLineItem", "Product": "01tSG000008KnvSYAS", "id": "0QLSG000000dIxz4AE", "ProductCode": "medPay", "SalesTransactionItemAttribute": \[\], "childNodes": \[\] } \] } \], "TotalStandardAmount": 680.8 } \] }, "productDetails": { "auto": { "attributeCategories": \[ { "attributes": \[ { "attributeCategoryId": "0v3SG0000001ZToYAM", "attributeNameOverride": "Bodily Injury Per Person Limit", "attributePicklist": { "id": "0v5SG0000004YXzYAM", "values": \[ { "code": "BIPD500", "displayValue": "$500", "id": "0v6SG0000006Vl2YAE", "name": "BIPD500", "sequence": 1, "status": "Active", "textValue": "500.0" } \] }, "code": "BodilyInjuryPerPersonLimit", "dataType": "PICKLIST", "developerName": "Bodily\_Injury\_Per\_Person\_Limit", "id": "0tjSG0000006q7RYAQ", "isCloneable": false, "isConfigurable": false, "isHidden": true, "isPriceImpacting": false, "isReadOnly": false, "isRequired": false, "label": "Bodily Injury Per Person Limit", "name": "Bodily Injury Per Person Limit", "status": "Active" } \], "code": "Auto Term", "name": "Auto Term" } \], "id": "01tSG000008KnvBYAS", "isActive": true, "isAssetizable": true, "isConfigurable": true, "isSoldOnlyWithOtherProds": false, "name": "Auto", "nodeType": "bundleProduct", "productClassification": { "id": "11BSG00000LARcM2AX" }, "productCode": "auto" } }, "uiTreatments": \[ { "details": { "attributeId": "0tjxx0000000007AAA", "stiId": "0QLxx0000004CU0GAM", "attributePicklistValueId": "0v6xx0000000005AAA" }, "uiTreatmentTarget": "Attribute\_Picklist\_Value", "uiTreatmentType": "Hide" }, { "details": { "stiId": "ref\_f0f2da7b\_c431\_482d\_bf4b\_599052f3a2e1" }, "uiTreatmentTarget": "Component", "uiTreatmentType": "Disable" } \], "ratingResult": { "childNodes": \[ { "childNodes": \[ { "childNodes": \[\], "details": { "NetUnitPrice": 590.4, "InstanceKey": "bipd1", "ProductCode": "bipd", "NetTotalPrice": 590.4, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 1485.84, "InstanceKey": "AutoSilver", "ProductCode": "autoSilver", "NetTotalPrice": 1485.84, "ProratedQLITaxAmount": 0 } } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | configMessages | [Insurance Config Message](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_config_message_output.htm "Output representation of configurator messages.")\[\] | List of configurator messages. | Small, 63.0 | 63.0 | | contextId | String | ID of the context. | Small, 61.0 | 61.0 | | contextJSON | [Context JSON](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_context_j_s_o_n_output.htm "Output representation for the context JSON.")\[\] | Serialized JSON representation of the context. | Small, 66.0 | 66.0 | | errors | | List of errors that are encountered during the processing of the API request. | Small, 61.0 | 61.0 | | pricingResult | Map | Details of the pricing result. | Small, 61.0 | 61.0 | | productDetails | [Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/connect_responses_product_output.htm "HTML (New Window)")\[\] | Details of the list of products that are included in the context JSON. | Small, 66.0 | 66.0 | | ratingResult | [Rating Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_result_output.htm "Output representation for the details of the product rating pricing results.")\[\] | Rating results after executing pricing with the context. | Small, 66.0 | 66.0 | | uiTreatments | [Insurance UI Treatments](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_u_i_treatment_output.htm "Output representation for the details of the insurance UI treatments.")\[\] | Details of the insurance UI configuration. | Small, 66.0 | 66.0 | # Product Surcharge Bulk Post Input Input representation of the details of the product surcharge records. ## JSON Example { "records": \[ { "name": "AutoVehicleTax", "surchargeId": "01cLO000000EMslOKL", "rootProductId": "01tDR000000EMslYAG", "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "isProrationEligible": true, "isRefundEligible": true, "isActive": true, "ruleApiName": "autoVehicleTaxRule", "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", "productRelatedComponent": "", "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", "productRelatedComponent": "", "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" \] } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | records | [Product Surcharge Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_surcharge_post_input.htm "Input representation of product surcharge details.")\[\] | List of the product surcharges. | Required | 63.0 | # Product Surcharge List Output Representation for List of ProductSurcharge | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | Map> | List of errors encountered during the processing of the API request. | Big, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Big, 63.0 | 63.0 | | records | String\[\] | Product surcharge records that are created. | Big, 63.0 | 63.0 | # Product Surcharge Patch Output representation of product surcharge update. ## JSON Example This request shows a sample success response. { "errors":\[\] "isSuccess":true "productSurchargeId":"1Xrxx000000003F" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail Output](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_detail_output.htm "Output representation of the error details.")\[\] | List of errors encountered during the processing of the API request. | Big, 63.0 | 63.0 | | isSuccess | Boolean | Indicates whether the API request is successful ( true) or not ( false). | Big, 63.0 | 63.0 | | productSurchargeId | String | ID of the product surcharge. | Big, 63.0 | 63.0 | # Product Surcharge Patch Input Input representation for product surcharge patch request. ## JSON Example { "name": "AutoVehicleTax", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "isProrationEligible": true, "isRefundEligible": true, "isActive": true, "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle" "ruleDefinition": \[ // ruleDefinition will be replaced as a whole. Updating only one condition is not supported { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Gold. "productRelatedComponent" : "", "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" // Auto Vehicle. \] }, { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Comprehensive Deductible", "type": "Attribute", "attributePicklistValueId": null, "attributeId": "0tjDR00000000UaYAI", "dataType": "Number", "values": \[ "$5000" \] } \], "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle "productRelatedComponent" : "", "criteriaIndex": 2, "sourceContextTagName": "Product", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "01tDR000000EMsoYAG" // Comprehensive Product. \] } \], "sequenceNumber": 0 } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveFromDate | String | Effective from date of the product surcharge. | Optional | 63.0 | | effectiveToDate | String | Effective to date of the product surcharge. | Optional | 63.0 | | isActive | Boolean | Indicates whether the product surcharge is active (true) or not (false). Currently, only active product surcharges are supported. | Optional | 63.0 | | isProrationAllowed | Boolean | Indicates whether the product surcharge is allowed for proration (true) or not (false). | Optional | 63.0 | | isRefundAllowed | Boolean | Indicates whether the product surcharge is allowed for refund (true) or not (false). | Optional | 63.0 | | name | String | Name of the product surcharge. | Optional | 63.0 | | productPath | String | A path containing the product IDs that roll up to the parent product. | Optional | 63.0 | | productRelatedComponentId | String | Product related component associated with the product surcharge. | Optional | 63.0 | | ruleApiName | String | Rule API name associated with product surcharge. You can set the ruleApiName with the POST or PATCH method. Once set, this parameter can’t be changed. If you set the ruleApiName in the request body, you must also set the ruleCriteria. | Optional | 63.0 | | ruleCriteria | [Insurance Rule Criteria Input\[\]](connect_requests_insurance_rule_criteria_input.htm "Input representation details of the insurance rule criteria.") | Rule criteria for the dynamic rule. | Optional | 63.0 | | sequenceNumber | Integer | Order in which surcharges are calculated when multiple surcharges are applied to a product. | Optional | 67.0 | # Product Surcharge Post Input Input representation of product surcharge details. ## JSON Example { "name": "AutoVehicleTax", "surchargeId": "01cLO000000EMslOKL", "rootProductId": "01tDR000000EMslYAG", "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", "effectiveFromDate": "2024-05-30T10:30:00", "effectiveToDate": "2024-11-01T10:30:00", "isProrationEligible": true, "isRefundEligible": true, "isActive": true, "ruleApiName": "autoVehicleTaxRule", "ruleCriteria": \[ { "conditions": \[ { "contextTagName": "SalesTransactionItemAttribute", "operator": "LessThan", "conditionIndex": 1, "attributeName": "Annual Milage", "attributePicklistValueId": null, "type": "Attribute", "attributeId": "0tjDR00000000VGYAY", "dataType": "Number", "values": \[ "50000" \] } \], "rootObjectId": "01tDR000000EMslYAG", "productRelatedComponent": "", "criteriaIndex": 1, "sourceContextTagName": "ProductBasedOn", "sourceOperator": "Equals", "sourceDataType": "String", "sourceValues": \[ "11BDR00000000T72AI" \] } \], "sequenceNumber": 0 } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | effectiveFromDate | String | Effective from date of the product surcharge. | Optional | 63.0 | | effectiveToDate | String | Effective to date of the product surcharge. | Optional | 63.0 | | isActive | Boolean | Indicates whether the product surcharge is active (true) or not (false). Currently, only active product surcharges are supported | Optional | 63.0 | | isProrationAllowed | Boolean | Indicates whether the product surcharge is allowed for proration (true) or not (false). | Optional | 63.0 | | isRefundAllowed | Boolean | Indicates whether the product surcharge is allowed for refund (true) or not (false). | Optional | 63.0 | | name | String | Name of the product surcharge. | Required | 63.0 | | productPath | String | A path containing the product IDs that roll up to the parent product. | Required | 63.0 | | productRelatedComponentId | String | ID of the product related component associated with the product surcharge. | Optional | 63.0 | | rootProductId | String | ID of the root product associated with the product surcharge. | Required | 63.0 | | ruleApiName | String | Rule API name associated with product surcharge. | Optional | 63.0 | | ruleCriteria | [Insurance Rule Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_rule_criteria_input.htm "Input representation details of the insurance rule criteria.")\[\] | Rule criteria of the dynamic rule for the product surcharge. | Optional | 63.0 | | sequenceNumber | Integer | Order in which surcharges are calculated when multiple surcharges are applied to a product. | Optional | 67.0 | | surchargeId | String | ID of the surcharge associated with the product surcharge. | Required | 63.0 | # putInsuranceIndividualMta(insuranceIndividualMtaInputParam, memberId) Apply a mid-term adjustment to the insurance policies of a group census member. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsuranceIndividualMtaOutputRepresentation putInsuranceIndividualMta(ConnectApi.InsuranceIndividualMtaInputRepresentation insuranceIndividualMtaInputParam, String memberId) ## Parameters **insuranceIndividualMtaInputParam** - Type: [ConnectApi.InsuranceIndividualMtaInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_individual_mta.htm "Input representation for applying a mid-term adjustment to a group census member's insurance policies.") - Optional flow, plan, and repricing settings that are used to apply the mid-term adjustment to the member's policies. **memberId** - Type: String - ID of the group census member whose policies are adjusted. ## Return Value Type: [ConnectApi.InsuranceIndividualMtaOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_individual_mta_output.htm "Output representation that's returned after a mid-term adjustment is applied to a group census member's insurance policies.") # Quote Management Create quotes from existing contracts and apply member-level plan overrides. - **[Create Quote From Insurance Contract Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote_from_contract.htm)** Create an endorsement or renewal quote from an existing contract for group insurance. - **[Apply Member Overrides Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_apply_member_overrides.htm)** Apply member-specific overrides that differ from the member’s group class default configuration on a group insurance quote. Use this action to apply plan, coverage, or attribute overrides, or to clone an override configuration from one group census member to one or more target group census members on the same root plan. Cloning replaces each target member’s existing override configuration. - **[Revert Member Overrides Action](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_revert_member_overrides.htm)** Revert all overrides for a member under a root quote line item and restore the member details to the default configuration of the group class. # Quote Management Create quotes from existing contracts and apply member-level plan overrides. - **[Create Endorsement or Renewal Quote From Insurance Contract (POST)](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. - **[Member Benefits Configuration Override (POST, DELETE)](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. # QuoteLineItemInsProductClause Represents all clauses associated with the products that are applicable to a specific quote line item. For example, if auto insurance quote "ABC" includes both a Free Look clause and an Excluded Driver clause, the object will have two records, one for each clause applicable to the quote line item. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ClauseText - **Type**: textarea - **Properties**: Create, Update - **Description**: The generated clause text based on rule evaluation. ### ConstraintModelDeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The developer name of the the constraint model used to generate clauses. ### CreationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: Indicates how the quote item insurance product clause is added. - **Possible values**: - AutoAdded - Manual ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The description of the quote item insurance product clause. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the quote item insurance product clause becomes active. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the quote item insurance product clause becomes inactive. ### InsuranceProductClauseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the insurance product clause associated with the quote item insurance product clause. This field is a relationship field. - **Relationship Name**: InsuranceProductClause - **Refers To**: InsuranceProductClause ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort - **Description**: The name of the quote item insurance product clause. ### QuoteLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The quote line item associated with the quote item insurance product clause. This field is a relationship field. - **Relationship Name**: QuoteLineItem - **Relationship Type**: Master-detail - **Refers To**: QuoteLineItem (the master object) # Rate Plan Output representation of the details of the rate plans associated directly with the policy or through coverages. ## JSON Example This example shows a sample success response. "ratePlans": \[ { "id": "rp11", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": 100, "type": "FlatPercentOfPremium" } \] }, { "id": "rp12", "totalPremiumAmount": 350, "totalFeeAmount": 200, "totalPremiumEqvAmount": 100, "expectedRevenueAmount": 45, "ratePlanCommissions": \[ { "id": "rpc111", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "id": "rpc112", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 10000 }, \] } \] | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | expectedRevenue​Amount | Double | Expected revenue amount for the specified policy. | Small, 63.0 | 63.0 | | id | String | ID of the rate plan. | Small, 63.0 | 63.0 | | ratePlan​Commissions | [Rate Plan Commission](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rate_plan_commission_output.htm "Output representation details of the rate plan commission.")\[\] | Details of the rate plan commissions. | Small, 63.0 | 63.0 | | totalFee​Amount | Double | Total fee amount that's calculated for rate plan and then rolled up to policy. | Small, 63.0 | 63.0 | | totalPremium​Amount | Double | Total premium amount that's calculated for rate plan and then rolled up to policy. | Small, 63.0 | 63.0 | | totalPremium​EqvAmount | Double | Total premium equivalent amount that's calculated for rate plan and then rolled up to policy. | Small, 63.0 | 63.0 | # Rate Plan Commission Output representation details of the rate plan commission. ## JSON Example This example shows a sample success response. \[ { "id": "rpc111", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 0, "amountEndRange": 1000 }, { "id": "rpc112", "premiumPercent": null, "type": "GradedPercent", "amountStartRange": 1001, "amountEndRange": 10000 }, \]
Property Name Type Description Filter Group and Version Available Version
amountEndRange Double End range of amount for graded percent of premium. Small, 63.0 63.0
amountStartRange Double Start range of amount for graded percent of premium. Small, 63.0 63.0
fee Double Commission fee when flat fee or capitated fee is selected. Small, 63.0 63.0
feePercent Double Percentage of fee earned as commission when flat percentage of fee is selected. Small, 63.0 63.0
id String ID of the rate plan commission. Small, 63.0 63.0
numberEndRange Integer End range of the grade volume, which represents the employee count. Small, 63.0 63.0
numberStartRange Integer Start range of the grade volume, which represents the employee count. Small, 63.0 63.0
premiumPercent Double Percentage of premium earned as commission when graded percent of premium or flat percent of premium is selected. Small, 63.0 63.0
type String Type of commission structure. Valid values are:
  • Flat Percent of Premium
  • Flat Fee
  • Graded Percent of Premium
  • Graded Volume
  • Capitated Fee
  • Flat percent of Fee
Small, 63.0 63.0
# Rating Input Node Input representation of details of context node. ## JSON Example { "ratingInputs": \[ { "instanceKeys": \[ "AutoRoot" \], "productCode": "AUTOROOT", "attributes": { "Deductible": 1000 } }, { "instanceKeys": \[ "AutoRoot", "Audi" \], "productCode": "AUTO", "attributes": { "Mileage": 20000 } }, { "instanceKeys": \[ "AutoRoot", "Audi", "Tom" \], "productCode": "DRIVER", "attributes": { "DriverAge": 50, "DriverAccident": 0 }, "targetRecords": \[ "003xx000004WkvEAAS" \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Optional | 63.0 | | attributes | Map | Map of attributes key-value pairs that's used to determine pricing. | Optional | 63.0 | | instanceKeys | String\[\] | List of instance keys for context path. | Required | 63.0 | | productCode | String | Unique code to identify a product. | Required | 63.0 | | reusable | Boolean | Indicate whether the node is reusable across multiple roots (true) or not (false). | Optional | 66.0 | | targetRecords | String\[\] | List of target records. | Optional | 63.0 | # Rating Input Node Response Output representation of a single node in the rating input hierarchy. ## JSON Example { "additionalFields": {}, "attributes": {}, "instanceKeys": \[ "Key1" \], "productCode": "ProductCode1" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additionalFields | Map | Map of additional fields that must be updated in the quote context. | Big, 66.0 | 66.0 | | attributes | Map | Map of product-specific attributes in key-value pairs that are used to determine pricing. | Big, 66.0 | 66.0 | | instanceKeys | String\[\] | List of the instance keys for the product hierarchy. | Big, 66.0 | 66.0 | | productCode | String | Unique code to identify a product. | Big, 66.0 | 66.0 | # Rating Options Output representation of the rating options that are returned in the response. ## JSON Example { "executeConfigurationRules": true, "executePricing": true, "returnContextJSON": true, "returnProductDetails": true } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | executeConfiguration​Rules | Boolean | Indicates whether to execute the configuration rules (true) or not (false). | Big, 66.0 | 66.0 | | executePricing | Boolean | Indicates whether to execute the pricing (true) or not (false). | Big, 66.0 | 66.0 | | returnContext​JSON | Boolean | Indicates whether to return the context JSON (true) or not (false). | Big, 66.0 | 66.0 | | returnProduct​Details | Boolean | Indicates whether to return the product details (true) or not (false). | Big, 66.0 | 66.0 | # Rating Options Input Input representation details of rating service options. ## JSON Example { "ratingOptions": { "executeConfigurationRules": true, "executePricing": true, "returnContextJSON": true, "returnProductDetails": true } } ## Properties
Name Type Description Required or Optional Available Version
executeConfiguration​Rules Boolean Indicates whether to execute configuration rules. Optional 63.0
executePricing Boolean Indicates whether to execute pricing. Optional 63.0
pricingProcedure String Name of the associated pricing procedure.

This property is deprecated in API version 66.0 and later.

 Optional 63.0
returnContext​JSON Boolean Indicates whether context details must be shown in the response (true) or not (false). Optional 66.0
returnProduct​Details Boolean Indicates whether product details must be shown in the response (true) or not (false). Optional 66.0
returnRating​Results Boolean Indicates whether rating results must be shown in the response (true) or not (false). Optional 66.0
# Rating Result Output representation for the details of the product rating pricing results. ## JSON Example { "ratingResult": { "childNodes": \[ { "childNodes": \[ { "childNodes": \[\], "details": { "NetUnitPrice": 590.4, "InstanceKey": "bipd1", "ProductCode": "bipd", "NetTotalPrice": 590.4, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 1485.84, "InstanceKey": "AutoSilver", "ProductCode": "autoSilver", "NetTotalPrice": 1485.84, "ProratedQLITaxAmount": 0 } } \] } } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | childNodes | [Rating Result](# "Output representation for the details of the product rating pricing results.")\[\] | List of child nodes for which the rating results are calculated. | Small, 66.0 | 66.0 | | details | Map | Details of the rating result of the parent node. | Small, 66.0 | 66.0 | # Recalculate Adjustments Action Recalculate the adjusted amount for a claim loss item to the maximum amount that’s allowed by the insurance policy. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/recalculateAdjustments Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | recalcAdjustmentsInputRep | Apex-defined | Required. An Apex ConnectApi.RecalcAdjustmentsInputRep record that contains the claim details to recalculate the adjusted amount for an existing claim coverage payment detail record. | ## Outputs | Output | Type | Description | | --- | --- | --- | | calculateAdjustmentsOutputRep | Apex-defined | An Apex ConnectApi.CalcAdjustmentsOutputRep record containing the calculated adjusted amount and the updated insurance policy limit tracking details. | ## Example **POST** This sample request is for the Recalculate Adjustments action. { "inputs": \[ { "recalcAdjustmentsInputRep": { "claimId": "0ZkSB0000000tqv0AA", "claimCoverageId": "0kPSB000000G72L2AS", "claimedAmount": "1000", "paymentDetailId": "0l2xx0000000001CAA", "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false } } } \] } This sample response is for the Recalculate Adjustments action. \[ { "actionName": "recalculateAdjustments", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "calculateAdjustmentsOutputRep": { "adjustedAmount": 1250, "adjustmentReason": "Deductible applied.", "claimCovPaymentAdjustments": \[ { "adjustedAmount": 250, "adjustmentReason": "Deductible" } \], "insPolicyLimitTrackings": \[ { "policyLimitId": "0lYx00000004CvQEAU", "category": "Per-Incident Limit", "remainingAmount": 4750 } \] } }, "sortOrder": -1, "version": 1 } \] # Recalculate Adjustments Input Input representation for recalculating the adjustments for existing payment details. ## JSON Example { "additionalFields": { "LimitUnitOfMeasure": "Visits", "LimitUnitCount": 2, "Network\_Type\_\_c": "Car Rental Network", "Claimant\_Phone\_\_c": "123456789", "Claimant\_Email\_\_c": "test@email.com", "Discount\_Percent\_\_c": 50, "EditedDateTime\_\_c": "2026-03-25T11:50:00.000Z", "IsPaid\_\_c": false }, "claimedAmount": 1200, "paymentDetailId": "0l2xx0000000001CAA" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | String | Additional standard or custom fields to recalculate the adjusted amount for an existing payment detail record. | Optional | 67.0 | | claimedAmount | Double | Amount requested by the claimant when submitting the loss. | Optional | 66.0 | | paymentDetailId | String | ID of the claim coverage payment detail for recalculating adjustments. | Optional | 66.0 | # RecalculateAdjustments(claimId, coverageId, RecalculateAdjustmentsInput) Recalculate adjustments for existing payment details. ## API Version 66.0 ## Requires Chatter No ## Signature public static ConnectApi.CalculateAdjustmentsRepresentation RecalculateAdjustments(String claimId, String coverageId, ConnectApi.RecalculateAdjustmentsInputRep RecalculateAdjustmentsInput) ## Parameters **claimId** - Type: String - ID of the claim for which the adjustments must be recalculated. **coverageId** - Type: String - ID of the claim coverage. **RecalculateAdjustmentsInput** - Type: [ConnectApi.RecalculateAdjustmentsInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_recalculate_adjustments.htm "Input representation for recalculating the adjustments for existing payment details.") - Details to recalculate the adjustments. ## Return Value Type: [ConnectApi.CalculateAdjustmentsRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_calculate_adjustments.htm "Output representation of the details for calculating the adjustments for the claim loss item.") ## Example **Class Definition** This is a sample Apex code to define the RecalculateAdjustments class before you can call it from Apex to recalculate payment adjustments. public with sharing class RecalculateAdjustmentsCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'recalculateAdjustments') { // Retrieve the required parameters from the input map String claimId = (String) inputMap.get('claimId'); String claimCoverageId = (String) inputMap.get('claimCoverageId'); ConnectApi.RecalculateAdjustmentsInputRep recalculateAdjustmentInputRep = (ConnectApi.RecalculateAdjustmentsInputRep) inputMap.get('RecalculateAdjustmentsInput'); System.debug('Start of connect API call to recalculate adjustments'); System.debug('Claim ID: ' + claimId); System.debug('Claim Coverage ID: ' + claimCoverageId); // Initialize the output representation ConnectApi.CalculateAdjustmentsRepresentation reCalcAdjResponse; // Call the Connect API to recalculate adjustments try { // Call the Connect API resource directly // The endpoint is: /connect/insurance/claims/${claimId}/coverages/${coverageId}/recalculate-adjustments reCalcAdjResponse = ConnectApi.InsuranceClaimFamily.RecalculateAdjustments( recalculateAdjustmentInputRep, claimId, claimCoverageId ); System.debug('Recalculate adjustments completed successfully: ' + reCalcAdjResponse); // Put the reCalcAdjResponse in the output map outputMap.put('reCalcAdjResponse', reCalcAdjResponse); outputMap.put('isSuccess', reCalcAdjResponse.isSuccess); // Check if there are any errors if (reCalcAdjResponse.errors != null && !reCalcAdjResponse.errors.isEmpty()) { outputMap.put('errors', reCalcAdjResponse.errors); System.debug('Errors found: ' + reCalcAdjResponse.errors); } } catch (Exception e) { System.debug('Error while recalculating adjustments: ' + e.getMessage()); outputMap.put('error', e.getMessage()); outputMap.put('isSuccess', false); } return reCalcAdjResponse; } // If the action is not recognized, return null return null; } } **Usage Example** This example shows how to call the RecalculateAdjustmentsCallable class from Apex and include the required input data. RecalculateAdjustmentsCallable callable = new RecalculateAdjustmentsCallable(); // Prepare the input arguments Map input = new Map(); // Set the required parameters input.put('claimId', '0ZkSB0000001AVH0A2'); // Claim ID input.put('claimCoverageId', '0kPSB000000GHdu2AG'); // Create the input representation object // First create a Map with the properties Map recalculateAdjustmentInputMap = new Map(); recalculateAdjustmentInputMap.put('paymentDetailId', '0l2SB000000CLsMYAW'); recalculateAdjustmentInputMap.put('claimedAmount', 4252.35); // Convert the Map to ConnectApi.RecalculateAdjustmentsInputRep using JSON.deserialize String jsonString = JSON.serialize(recalculateAdjustmentInputMap); ConnectApi.RecalculateAdjustmentsInputRep recalculateAdjustmentInputRep = (ConnectApi.RecalculateAdjustmentsInputRep) JSON.deserialize(jsonString, ConnectApi.RecalculateAdjustmentsInputRep.class); input.put('RecalculateAdjustmentsInput', recalculateAdjustmentInputRep); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'recalculateAdjustments' action Object result = callable.call('recalculateAdjustments', args); // Check the result if (result != null) { System.debug('recalculateAdjustments processed successfully: ' + result); // Access the processed adjustment data ConnectApi.CalculateAdjustmentsRepresentation reCalcAdjResponse = (ConnectApi.CalculateAdjustmentsRepresentation) result; // Process the result as needed System.debug('recalc Adjustment response: ' + reCalcAdjResponse); // Check if the response was successful if (reCalcAdjResponse.isSuccess) { System.debug('recalculateAdjustment was successful'); } else { System.debug('recalculateAdjustment failed'); if (reCalcAdjResponse.errors != null) { System.debug('Error details: ' + reCalcAdjResponse.errors); } } } else { System.debug('Error occurred: ' + output.get('error')); } # Refund Output representation of refund details. ## JSON Example refund": { "fee": 15.71, "premium": 31.42, "tax": 15.71 } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | fee | Double | Refund fee amount after cancellation. | Small, 63.0 | 63.0 | | premium | Double | Refund premium amount after cancellation. | Small, 63.0 | 63.0 | | tax | Double | Refund tax amount after cancellation. | Small, 63.0 | 63.0 | # Reinstate Insurance Brokerage Policy Action Reinstate a canceled insurance brokerage policy with optional reinstatement details. This action is available in API version 67.0 and later. ## Special Access Rules The Reinstate Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/reinstateInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_ReinstateBrokeragePolicyIAInputRep record that contains the ID of the canceled brokerage policy along with other optional details to reinstate. | ## Outputs | Output | Type | Description | | --- | --- | --- | | reinstatedPolicyId | string | ID of the reinstated policy. | | transactionId | string | Transaction ID that's generated during the policy reinstatement operation. | ## Example **POST** This sample request is for the Reinstate Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001", "reinstatementDate": "2026-07-15", "effectiveFromDate": "2026-07-15", "effectiveToDate": "2027-07-15" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for reinstating a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('reinstateInsBrokeragePolicy'); // Instantiate the input object ConnectApi.ReinstateBrokeragePolicyIAInputRep input = new ConnectApi.ReinstateBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the canceled brokerage policy to reinstate input.policyId = '0YjXX0000000001'; // Optional: Set reinstatement details input.reinstatementDate = '2026-07-15'; input.effectiveFromDate = '2026-07-15'; input.effectiveToDate = '2027-07-15'; // Set the invocation parameter and invoke action.setInvocationParameter('reinstateBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Reinstate Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Reinstate Insurance Brokerage Policy action. \[ { "actionName": "reinstateInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "reinstatedPolicyId": "0YjXX0000000001", "transactionId": "txn\_reinstate\_789" }, "sortOrder": -1, "version": 1 } \] # Reinstate Insurance Policy (POST) Reinstate a previously canceled insurance policy. If you want to calculate billing during insurance policy reinstatement, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/reinstate ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000004CdeFGH/reinstate ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the insurance policy to be reinstated. | Required | 65.0 | ## Request Body for POST ### JSON Example { "effectiveDate": "2025-09-15", "insurancePolicy": { "policyName": "Reinstate Auto Policy" }, "transactionRecord": { "name": "Reinstatement Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields": { "additionalFieldsList": \[ { "additionalFieldsMapValue": { "ReinstatementReason": "Payment Received" } } \] } } ### Properties
Name Type Description Required or Optional Available Version
additionalFields Additional Fields Map Value[] JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy parameter. Address and Geolocation field types are not supported as additional fields. Optional 65.0
billingRecord Insurance Policy Billing Details Billing details to calculate billing when reinstating the policy. Optional 67.0
effectiveDate String Date from the policy reinstatement becomes effective. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the reinstatement applies starting March 1, 2025.

Optional 65.0
insurancePolicy Insurance Policy Input Details of the insurance policy. It contains fields and values from the Insurance Policy object. Optional 65.0
transactionRecord Insurance Policy Transaction Input JSON structure that's used to override transaction information. Optional 65.0
## Response Body for POST [Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_output.htm "Output representation of policy details.") # Reinstate Insurance Policy Action Reinstate a previously canceled insurance policy. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/reinstateInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | reinstatePolicy​InputRep | Apex-defined | Required. An Apex [ConnectApi\_\_ReinstatePolicyInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_reinstate_policy_i_a_input_re.htm "Input representation for the Reinstate Insurance Policy Invocable Action.") record that contains the policy details to reinstate the insurance policy. To calculate billing, specify billingRecord details if Career Billing is enabled in your org. | ## Outputs | Output | Type | Description | | --- | --- | --- | | reinstatedPolicyId | string | ID of the reinstated insurance policy. | ## Example **POST** This is a sample request to call this invocable action. { "inputs": \[ { "ReinstatePolicyInputRep": { "policyId": "0YTxx0000004CdeFGH", "effectiveDate": "2024-12-30", "insurancePolicy": { "policyName": "Auto Insurance", "policyNumber": "PLC5678987", "effectiveFromDate": "2024-01-01", "effectiveToDate": "2024-12-31", "referencePolicyNumber": "PLC56011213" }, "transactionRecord": { "name": "Cancel Policy Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key": "AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key": "SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList": \[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key": "Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key": "PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for policy reinstatement Invocable.Action action = Invocable.Action.createStandardAction('reinstateInsurancePolicy'); // Instantiate the input object for the policy reinstatement ConnectApi.ReinstatePolicyInputRep policyInput = new ConnectApi.ReinstatePolicyInputRep(); // Required: Set the Policy ID of the policy to be reinstated policyInput.policyId = '0YTxx00000000PpGAI'; // Optional: Populate Insurance Policy details ConnectApi.InsPolicyIAInputRep insurancePolicy = new ConnectApi.InsPolicyIAInputRep(); insurancePolicy.policyName = 'Health Insurance Policy Reinstated'; insurancePolicy.policyNumber = 'HIPE12'; // Assign the insurance policy input to the main input object policyInput.insurancePolicy = insurancePolicy; // Optional: Add additional input fields (custom fields, etc.) List additionalFields = new List(); ConnectApi.AdditionalFieldIARep additionalFieldElement = new ConnectApi.AdditionalFieldIARep(); additionalFieldElement.key = 'Currency\_\_c'; additionalFieldElement.value = '6700'; additionalFields.add(additionalFieldElement); // Create a wrapper for the additional input fields per policy instance List addlInputIARep = new List(); ConnectApi.InsPolicyAddlInputIARep addlInputIARepElement = new ConnectApi.InsPolicyAddlInputIARep(); addlInputIARepElement.instanceKey = 'AutoSilver'; // Logical key representing the policy instance addlInputIARepElement.additionalFieldsList = additionalFields; addlInputIARep.add(addlInputIARepElement); // Assign additional input to the main input object policyInput.additionalInput = addlInputIARep; // Optional: Populate Transaction record information ConnectApi.InsPolicyTrxnIAInputRep transactionRecord = new ConnectApi.InsPolicyTrxnIAInputRep(); transactionRecord.name = 'Apex IA Transaction'; // A label for the transaction policyInput.transactionRecord = transactionRecord; action.setInvocationParameter('ReinstatePolicyInputRep', policyInput); List results = action.invoke(); System.debug('Reinstate Invocable Action result = ' + results); This is a sample response when you call this action. \[ { "actionName": "reinstateInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "reinstatedPolicyId": "15Uxx0000004CUWEA2" }, "sortOrder": -1, "version": 1 } \] # Reinstate Policy (POST) Reinstate a canceled policy for the specified insurance policy ID. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/reinstate ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/0YTxx0000000001GAA/reinstate ## Available Version 67.0 ## HTTP Methods POST ## Request Parameters for POST | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | policyId | Id | ID of the canceled insurance policy to reinstate. The key prefix is 0YT. | Required | ## Request Body for POST ### JSON Example { "reinstatementDate": "2024-06-01", "insurancePolicy": { "policyName": "Reinstated Policy Name", "policyNumber": "POL-2024-001", "Custom\_field": "value" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insurancePolicy | Object | JSON object that contains insurance policy fields to override in the reinstated policy. The keys must be API names and are case sensitive. | Optional | 67.0 | | reinstatementDate | String | Date when the policy becomes effective. Use the format YYYY-MM-DD. | Required | 67.0 | ## Response Body for POST [Insurance Policy Reinstatement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_reinstatement_output.htm "Output representation details of the reinstate policy request.") # Reinstate Policy Input Input representation for reinstating an insurance policy. ## JSON Example { "effectiveDate": "2025-09-15", "insurancePolicy": { "policyName": "Reinstate Auto Policy" }, "transactionRecord": { "name": "Reinstatement Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields": { "additionalFieldsList": \[ { "additionalFieldsMapValue": { "ReinstatementReason": "Payment Received" } } \] } } ## Properties
Name Type Description Required or Optional Available Version
additionalFields Additional Fields Map Value[] JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy parameter. Address and Geolocation field types are not supported as additional fields. Optional 65.0
billingRecord Insurance Policy Billing Details Billing details to calculate billing when reinstating the policy. Optional 67.0
effectiveDate String Date from the policy reinstatement becomes effective. This date must be within the policy term.

For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the reinstatement applies starting March 1, 2025.

 Optional 65.0
insurancePolicy Insurance Policy Input Details of the insurance policy. It contains fields and values from the Insurance Policy object. Optional 65.0
transactionRecord Insurance Policy Transaction Input JSON structure that's used to override transaction information. Optional 65.0
# reinstateInsurancePolicy(insurancePolicyReinstatementInput, policyId) Reinstate a previously canceled insurance policy by providing the reinstatement details and the policy ID. ## API Version 67.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyReinstatementRepresentation reinstateInsurancePolicy(ConnectApi.InsurancePolicyReinstatementInputRepresentation insurancePolicyReinstatementInput, String policyId) ## Parameters **insurancePolicyReinstatementInput** - Type: [ConnectApi.InsurancePolicyReinstatement​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_reinstatement.htm "Input representation for the reinstate policy request. Includes insurance policy field overrides and the reinstatement date.") - Input representation containing the insurance policy field overrides and the reinstatement date. **policyId** - Type: String - ID of the insurance policy to reinstate. ## Return Value Type: [ConnectApi.InsurancePolicyReinstatementRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_reinstatement.htm "Output representation for the reinstate policy response. Contains the reinstated policy ID, the transaction ID, and any errors that occurred during the reinstatement process.") ## Usage Use this method to reinstate a previously canceled insurance policy. Provide the reinstatement date and any policy field overrides in the input representation, along with the ID of the policy to reinstate. The response includes the reinstated policy ID, the transaction ID, and any errors. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.reinstateInsurancePolicy() method to reinstate a previously canceled insurance policy. **Class Definition** This Apex example shows how to reinstate a canceled insurance policy. global class ReinstateConnectDriver { global static void callReinstateConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); ConnectApi.InsurancePolicyReinstatementInputRepresentation reinstateInput = new ConnectApi.InsurancePolicyReinstatementInputRepresentation(); reinstateInput.reinstatementDate = '2026-01-15'; ConnectApi.InsurancePolicyInputRepresentation policyInput = new ConnectApi.InsurancePolicyInputRepresentation(); Map fields = new Map(); fields.put('Status', 'Active'); policyInput.fieldValueMap = fields; reinstateInput.insurancePolicy = policyInput; input.put('policyInput', reinstateInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); ReinstateTestConnectAPI callable = new ReinstateTestConnectAPI(); Object result = callable.call('reinstate', args); ConnectApi.InsurancePolicyReinstatementRepresentation policyData = (ConnectApi.InsurancePolicyReinstatementRepresentation) result; System.debug('Reinstate Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the ReinstateTestConnectAPI class to execute the reinstate action and process the result. public class ReinstateTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'reinstate') { ConnectApi.InsurancePolicyReinstatementInputRepresentation reinstateInput = (ConnectApi.InsurancePolicyReinstatementInputRepresentation) inputMap.get('policyInput'); String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to reinstate policy: ' + policyId); ConnectApi.InsurancePolicyReinstatementRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.reinstateInsurancePolicy(reinstateInput, policyId); System.debug('Policy reinstated successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while reinstating policy: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute ReinstateConnectDriver.callReinstateConnectAPI(); # ReinstatePolicy(ReinstatePolicyInput, policyId) Reinstate a previously canceled insurance policy. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyOutputRepresentation ReinstatePolicy(ConnectApi.ReinstatePolicyInputRepresentation ReinstatePolicyInput, String policyId) ## Parameters **ReinstatePolicyInput** - Type: [ConnectApi.Reinstate​PolicyInput​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_reinstate_policy.htm "Input representation for reinstating an insurance policy.") - Input representation for reinstating an insurance policy. **policyId** - Type: String - ID of the insurance policy to be reinstated. ## Return Value Type: [ConnectApi.Policy​Output​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_policy_output.htm "Output representation of the policy details.") ## Example Here's an example of how to invoke the Reinstate Policy API by using Apex. // Create and populate the ReinstatePolicyInputRepresentation object ConnectApi.ReinstatePolicyInputRepresentation policyInput = new ConnectApi.ReinstatePolicyInputRepresentation(); // Populate fields for InsurancePolicyInputRepresentation ConnectApi.InsurancePolicyInputRepresentation insurancePolicy = new ConnectApi.InsurancePolicyInputRepresentation(); insurancePolicy.policyName = 'Health Insurance Policy Reinstated'; insurancePolicy.policyNumber = 'HIPE12'; // Create the list that will hold the AdditionalFieldsMapValue wrappers. List additionalFieldsValueList = new List(); // 1. Create the map containing the actual field data for ONE item. Map dataForFirstMapValue = new Map(); dataForFirstMapValue.put('instanceKey', 'AutoSilver'); // Example key/value from your JSON structure Map innerFieldsMap = new Map(); innerFieldsMap.put('Currency\_\_c', '4456'); // Example inner field value dataForFirstMapValue.put('fields', innerFieldsMap); // Put the inner fields map here // 2. Create an instance of the AdditionalFieldsMapValue wrapper for this item. ConnectApi.AdditionalFieldsMapValue firstMapValueWrapper = new ConnectApi.AdditionalFieldsMapValue(); // 3. Assign the map data (created in step 1) to the \*correct property\* on the wrapper instance. firstMapValueWrapper.additionalFieldsMapValue = dataForFirstMapValue; // 4. Add the populated wrapper instance to the list. additionalFieldsValueList.add(firstMapValueWrapper); // --- End of Populating the First Item --- // --- If you need more items in the list, repeat steps 1-4 for each --- // Assign the populated additional object to the policyInput policyInput.additionalFields = additionalFieldsValueList; policyInput.insurancePolicy = insurancePolicy; // Optionally populate InsurancePolicyTransactionInputRepresentation ConnectApi.InsurancePolicyTransactionInputRepresentation transactionRecord = new ConnectApi.InsurancePolicyTransactionInputRepresentation(); policyInput.transactionRecord = transactionRecord; // Optionally set the effective date // policyInput.effectiveDate = '2025-06-01'; try { // Call the Connect API directly ConnectApi.PolicyOutputRepresentation policyData = ConnectApi.InsurancePolicyAdminFamily.reinstatePolicy(policyInput, '0YTxx00000000MbGAI'); // Output the policy data to the debug log System.debug('Policy reinstated successfully: ' + JSON.serializePretty(policyData)); } catch (Exception e) { // Log the error System.debug('Error while reinstating policy: ' + e.getMessage()); } # Remaining Reserve Output representation for the remaining reserve amount and scope after the payment is processed. ## JSON Example { "remainingReserveAmount": 2500.00, "reserveLimitRecordId": null, "scope": "ClaimCoverage" } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | remainingReserve​Amount | Double | Reserve amount remaining after the payment is processed. | Small, 68.0 | 68.0 | | reserveLimit​RecordId | String | ID of the claim financial reserve limit record associated with a setup-time reserve. Shows null for a runtime reserve. | Small, 68.0 | 68.0 | | scope | String | Scope of the reserve. For a setup-time reserve, the value is Org or Product. For a runtime reserve, the value is Claim or ClaimCoverage. | Small, 68.0 | 68.0 | # Renew Contract (POST) Create a renewed insurance contract from a renewal quote, carrying forward the applicable contract details and line items for the next coverage term. ## Resource /connect/insurance/contracts/actions/renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/actions/renew ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000004CtoCAE", "renewalDate": "2026-03-11", "contractEndDate": "2027-03-11", "contractTerm": 12, "targetContractId": "800xx0000004C92AAE", "additionalFields": { "insuranceContractItemList": \[ { "entity": "Contract", "fields": { "data": \[ { "key": "Description", "value": "Renewed for FY2026" } \] } }, { "entity": "InsuranceContract", "fields": { "data": \[ { "key": "myCustomPickList\_\_c", "value": "Alive" }, { "key": "EnrollmentEndDate", "value": "2022-01-20" }, { "key": "EnrollmentStartDate", "value": "2021-01-20" } \] } }, { "entity": "ContractGroupPlan", "productPath": "dentalBasic", "fields": { "data": \[ { "key": "EnrollmentEndDate", "value": "2025-12-31" } \] } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm "Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote.")\[\] | List of additional fields to apply to contract objects when the renewed contract is created. | Optional | 68.0 | | contractEndDate | String | End date of the renewed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | contractTerm | Integer | Duration of the renewed contract in months. The default value is 12. | Optional | 68.0 | | quoteId | String | ID of the quote from which you want to create the renewed contract. | Required | 68.0 | | renewalDate | String | Date that the renewed contract term starts. Specify the date in the yyyy-MM-dd format. | Required | 68.0 | | targetContractId | String | ID of the existing contract that the renewal is based on, when you need to identify the prior contract explicitly. | Optional | 68.0 | ## Response Body for POST [Contract Renewal Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_renewal.htm "Output representation of the details when a renewed group benefits contract is created from a quote.") # Renew Contract Action Renew a group insurance contract by creating a new contract for the next term from a renewal quote, carrying forward the relevant contract details and line items. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewContract Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | insuranceContractRenewInputRepresentation | Apex-defined | Required. An Apex ConnectApi.InsuranceContractRenewalInputRepresentation record that contains the renewal quote details to renew an insurance contract. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insuranceContractRenewOutputRepresentation | Apex-defined | An Apex ConnectApi.InsuranceContractRenewalRepresentation record that contains the result of the contract renewal operation, including the new contract ID. | ## Example **POST** This sample request is for the Renew Contract action. { "inputs": \[ { "insuranceContractRenewInputRepresentation": { "quoteId": "0Q0xx0000004CtoCAE", "renewalDate": "2026-03-11", "contractEndDate": "2027-03-11", "contractTerm": 12, "targetContractId": "800xx0000004C92AAE", "additionalFields": \[ { "entity": "Contract", "productPath": "Root", "fields": \[ { "key": "CustomerSignedTitle", "value": "Mr" } \] } \] } } \] } This sample response is for the Renew Contract action. \[ { "actionName": "renewContract", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insuranceContractRenewOutputRepresentation": { "errors": \[\], "isSuccess": true, "message": "Contract renewed successfully from quote.", "contractId": "800xx0000004C92AAE" } }, "sortOrder": -1, "version": 1 } \] # Renew Group Census Member Policies Action Renew group census member policies for contract renewal. This action creates renewed insurance policies, and links the newly created policies to the previous policies. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewGroupCensusMemberPolicies Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractGroupPlanId | string | Required. ID of the contract group plan to process for member policy renewal. | | groupCensusMembers | sobject | Required. Group census member records to process for renewal. The members must have an active insurance policy under the contract being renewed. | | pricingResult | Apex-defined | A collection of Apex ind\_ins\_grpben\_\_MembersPlansRatingOutput records that contain pricing results for the member policies to be renewed. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insurancePolicyIds | string | IDs of the renewed policies for the group census members. | ## Example **POST** This sample request is for the Renew Group Census Member Policies action. { "inputs": \[ { "contractGroupPlanId": "0rgZM0000004C9NYAU", "groupCensusMembers": \[ { "attributes": { "type": "GroupCensusMember" }, "Id": "0rhZM0000004C9NYAU", "GroupCensusId": "0rfZM0000008OIFYA2", "AccountId": "001ZM000002jgdjYAA", "AssociationWithPrimaryMbr": "Self", "EventEffectiveDate": "2027-08-10" } \], "pricingResult": \[ { "attributes": { "type": "ind\_ins\_grpben\_\_MembersPlansRatingOutput" }, "groupCensusMemberId": "0rhZM0000004C9NYAU", "contractGroupPlanId": "0rgZM0000004C9NYAU", "totalPremium": 300 } \] } \] } This sample success response is for the Renew Group Census Member Policies action. \[ { "actionName": "renewGroupCensusMemberPolicies", "isSuccess": true, "errors": null, "outputValues": { "insurancePolicyIds": \[ "0YTZM0000009AbC4AU" \] } } \] This sample response with errors for the Renew Group Census Member Policies action. \[ { "actionName": "renewGroupCensusMemberPolicies", "isSuccess": false, "errors": \[ { "statusCode": "SOMETHING\_UNEXPECTED\_HAPPENED", "message": "Something went wrong. Ask your Salesforce admin for help.", "fields": \[\] } \], "outputValues": { "insurancePolicyIds": null } } \] # Renew Insurance Brokerage Policy Action Renew an insurance brokerage policy with optional policy detail overrides. This action is available in API version 67.0 and later. ## Special Access Rules The Renew Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewInsBrokeragePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | inputRep | Apex-defined | Required. An Apex ConnectApi\_\_RenewBrokeragePolicyIAInputRep record that contains the ID and other details of the original brokerage policy to renew. | ## Outputs | Output | Type | Description | | --- | --- | --- | | renewedPolicyId | string | ID of the newly created renewed policy. | ## Example **POST** This sample request is for the Renew Insurance Brokerage Policy action. { "inputs": \[ { "inputRep": { "policyId": "0YjXX0000000001", "effectiveFromDate": "2027-01-01", "effectiveToDate": "2028-01-01", "policyName": "Renewed Policy 2027", "policyNumber": "POL-2027-RENEW" } } \] } This is a sample request to call this invocable action from Apex code. // Create the standard Invocable Action for renewing a brokerage policy Invocable.Action action = Invocable.Action.createStandardAction('renewInsBrokeragePolicy'); // Instantiate the input object ConnectApi.RenewBrokeragePolicyIAInputRep input = new ConnectApi.RenewBrokeragePolicyIAInputRep(); // Required: Set the Policy ID of the original brokerage policy to renew input.policyId = '0YjXX0000000001'; // Optional: Set renewal details input.effectiveFromDate = '2027-01-01'; input.effectiveToDate = '2028-01-01'; input.policyName = 'Renewed Policy 2027'; input.policyNumber = 'POL-2027-RENEW'; // Set the invocation parameter and invoke action.setInvocationParameter('renewBrokeragePolicyIAInputRep', input); List results = action.invoke(); System.debug('Renew Brokerage Policy Invocable Action result = ' + results); This is the sample response for the Renew Insurance Brokerage Policy action. \[ { "actionName": "renewInsBrokeragePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "renewedPolicyId": "0YjXX0000000100" }, "sortOrder": -1, "version": 1 } \] # Renew Insurance Policies Action Process the renewal of insurance policies in bulk. This action is available in API version 64.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewInsurancePolicies Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | renewInsurance​Policies​IAInputRep | Apex-defined | Required. A collection of Apex input records that contain details of the insurance policies to be renewed. See [ConnectApi.RenewInsurancePoliciesIAInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_renew_ins_policy_async_i_a_input_re.htm "An Apex ConnectApi.RenewInsurancePoliciesIAInputRep record that contains the details of the insurance policies to be renewed.") for the list of input parameters. | ## Outputs No output representation as it's an async invocable action, which publishes the request to a queue for processing. ## Example **POST** This example shows a sample request for the Renew Insurance Policies action. { "inputs": \[ { "RenewInsurancePoliciesIAInputRep": { "policyId": "0YTIU000000xUi14AE", "jobIdentifier": "testJob368", "executeConfigurationRules": true, "executeQualificationRules": true, "issueQuote": false, "sameTenure": true "priceBookId": "01sxx0000005pyfAAA", "productSellingModel": "One Time", "flowAPINameWithNamespace":"abc", "executePricing": false, "fieldSetIds" : { "policyFieldSetId":"0YTIU000000xUi14AE", "assetFieldSetId" : "0YTIU000000xUi14AE", "participantFieldSetId" : "0YTIU000000xUi14AE", "coverageFieldSetId" : "0YTIU000000xUi14AE", } } } \] } # Renew Insurance Policy (POST) Use the context ID of an existing policy to renew the policy. Modify the renewal date and also add optional fields and additional information in the request body. If you want to calculate billing during an insurance policy renewal process, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org. ## Resource {policyId} is a placeholder. /connect/insurance/policies/{policyId}/renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx00000000WHGAY/renew ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "insurancePolicy": { "policyName": "Demo Test Policy 9", "policyNumber": "test renew policy", "effectiveFromDate": "2025-03-15", "effectiveToDate": "2026-03-15" }, "transactionRecord":{ "name": "Renew Payment" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } } { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when renewing the policy. | Optional | 67.0 | | contextId | String | Priced context ID of the policy or quote that's used to renew the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.") \[\] | JSON structure that's used to override the transaction information. | Optional | 63.0 | ## Response Body for POST [Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_output.htm "Output representation of policy details.") # Renew Insurance Policy Action Renew an insurance policy by using a set of user inputs that represent policy details. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Details
renewPolicyIAInputRep Type

Apex-defined

Description

An Apex ConnectApi.RenewPolicyIAInputRep record that contains the details of the policy to be renewed.
## Outputs
Output Details
renewedPolicyId Type

String

Description

ID of the renewed policy.
## Example Sample Request { "inputs": \[ { "RenewPolicyIAInputRep": { "contextId": "d767b27ec095f9f95c5a34299e3bd6f507df23e8d0692dfed17f98dcb5b661b6", "policyId": "0YTxx00000001ovGAA", "insurancePolicy": { "policyName": "Renewed\_Auto\_Policy\_00002", "policyNumber": "Renewed Auto Policy 00002", "effectiveFromDate": "2025-01-01", "effectiveToDate": "2025-12-31" }, "transactionRecord": { "name": "Renew Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key": "AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key": "SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList": \[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key": "Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key": "PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } Sample Response \[ { "actionName": "renewInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "renewedPolicyId": "0YTSG000000PgX74AK" }, "sortOrder": -1, "version": 1 } \] # Renew Multi-Root Insurance Policy Action Renew an existing multi-root insurance policy along with its associated child policies asynchronously. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/renewMultiRootInsurancePolicy Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | renewMultiRootPolicyInputRep | Apex-defined | Required. An Apex ConnectApi.RenewMultiRootPolicyInputRep record that contains the details to renew the multi-root insurance policy. To calculate billing, specify billingRecord if Career Billing is enabled in your org. | ## Outputs | Output | Type | Description | | --- | --- | --- | | jobIdentifier | string | A unique system-generated ID for the job that processes the renewal of the multi-root insurance policy. | ## Example **POST** This sample request is for the Renew Multi-Root Insurance Policy action. { "inputs": \[ { "renewMultiRootPolicyInputRep": { "contextId": "d767b27ec095f9f95c5a34299e3bd6f507df23e8d0692dfed17f98dcb5b661b6", "policyId": "0YTxx00000001ovGAA", "insurancePolicy": { "policyName": "Renewed\_Auto\_Policy\_00002", "policyNumber": "Renewed Auto Policy 00002", "effectiveFromDate": "2025-01-01", "effectiveToDate": "2025-12-31" }, "transactionRecord": { "name": "Renew Transaction" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalInput": \[ { "instanceKey": "AutoBundle2", "additionalFieldsList": \[ { "key": "AssetDescription\_\_c", "value": "Test\_AssetDescription\_\_c" }, { "key": "SourceSystem", "value": "Test\_SourceSystem" } \] }, { "instanceKey": "AutoDriver", "additionalFieldsList": \[ { "key": "ParticipantName", "value": "Test\_ParticipantName" }, { "key": "Participant\_Hometown\_\_c", "value": "Test\_Participant\_Hometown\_\_c" } \] }, { "instanceKey": "AutoRoot", "additionalFieldsList": \[ { "key": "Primary\_Policy\_Holder\_\_c", "value": "Test\_Primary\_Policy\_Holder\_\_c" }, { "key": "PolicyDescription", "value": "Test\_PolicyDescription" } \] }, { "instanceKey": "AutoBundle2\_AutoComp1", "additionalFieldsList": \[ { "key": "Coverage\_Description\_\_c", "value": "Test\_Coverage\_Description\_\_c" }, { "key": "Description", "value": "Test\_Description" } \] } \] } } \] } This is a sample code to call the Renew Multi-Root Insurance Policy action from Apex. public with sharing class MultiRootPolicyRenewalInvocable { /\*\* \* Execute Multi-Root Policy Renewal with parameters map \* Usage: MultiRootPolicyRenewalInvocable.executeMultiRootRenewal(paramsMap); \* \* @param params Map of parameters: \* - contextId (String, REQUIRED) \* - policyId (String, REQUIRED) \* - policyName (String, optional) \* - effectiveFromDate (String, optional) \* - effectiveToDate (String, optional) \* - transactionName (String, optional) \* - additionalFields (Map>, optional) \*/ public static void executeMultiRootRenewal(Map params) { // Extract and validate contextId (REQUIRED) String contextId = (String) params.get('contextId'); if (String.isBlank(contextId)) { System.debug('ERROR: contextId is required'); return; } // Extract and validate policyId (REQUIRED) String policyId = (String) params.get('policyId'); if (String.isBlank(policyId)) { System.debug('ERROR: policyId is required'); return; } // Multi-Root Renew Policy IA - Create the standard Invocable Action Invocable.Action action = Invocable.Action.createStandardAction('renewMultiRootInsurancePolicy'); // Instantiate the IA input object for Multi-Root Policy Renewal // IMPORTANT: Use RenewMultiRootPolicyInputRep ConnectApi.RenewMultiRootPolicyInputRep policyInput = new ConnectApi.RenewMultiRootPolicyInputRep(); // Set context ID and policy ID (REQUIRED) policyInput.contextId = contextId; policyInput.policyId = policyId; // Extract optional parameters String policyName = (String) params.get('policyName'); String effectiveFromDate = (String) params.get('effectiveFromDate'); String effectiveToDate = (String) params.get('effectiveToDate'); String transactionName = (String) params.get('transactionName'); Map> additionalFields = (Map>) params.get('additionalFields'); // Populate Insurance Policy details (using IA classes) - all optional if (!String.isBlank(policyName) || !String.isBlank(effectiveFromDate) || !String.isBlank(effectiveToDate)) { ConnectApi.InsPolicyIAInputRep insurancePolicy = new ConnectApi.InsPolicyIAInputRep(); if (!String.isBlank(policyName)) { insurancePolicy.policyName = policyName; } if (!String.isBlank(effectiveFromDate)) { insurancePolicy.effectiveFromDate = effectiveFromDate; } if (!String.isBlank(effectiveToDate)) { insurancePolicy.effectiveToDate = effectiveToDate; } policyInput.insurancePolicy = insurancePolicy; } // Populate Transaction record (using IA transaction representation) - optional if (!String.isBlank(transactionName)) { ConnectApi.InsPolicyTrxnIAInputRep transactionRecord = new ConnectApi.InsPolicyTrxnIAInputRep(); transactionRecord.name = transactionName; policyInput.transactionRecord = transactionRecord; } // Populate additional input for multi-root policies - optional if (additionalFields != null && !additionalFields.isEmpty()) { List additionalInputList = new List(); for (String instanceKey : additionalFields.keySet()) { ConnectApi.InsPolicyAddlInputIARep additionalInput = new ConnectApi.InsPolicyAddlInputIARep(); // Set instance key (e.g., "AutoSilver", "FamilyHealth") additionalInput.instanceKey = instanceKey; // Build additional fields list for this instance Map fieldsMap = additionalFields.get(instanceKey); if (fieldsMap != null && !fieldsMap.isEmpty()) { List fieldsList = new List(); for (String fieldKey : fieldsMap.keySet()) { ConnectApi.AdditionalFieldIARep field = new ConnectApi.AdditionalFieldIARep(); field.key = fieldKey; field.value = fieldsMap.get(fieldKey); fieldsList.add(field); } additionalInput.additionalFieldsList = fieldsList; } additionalInputList.add(additionalInput); } policyInput.additionalInput = additionalInputList; } // Set invocation parameters // IMPORTANT: Parameter name is renewMultiRootPolicyInputRep (camelCase) action.setInvocationParameter('renewMultiRootPolicyInputRep', policyInput); System.debug('Starting Multi-Root Policy Renewal Invocable Action (renewMultiRootInsurancePolicy)...'); System.debug('Context ID: ' + contextId); System.debug('Policy ID: ' + policyId); if (!String.isBlank(policyName)) { System.debug('Policy Name: ' + policyName); } try { // Invoke the action List results = action.invoke(); System.debug('Multi-Root Policy Renewal IA result = ' + results); // Process results for (Invocable.Action.Result result : results) { if (result.isSuccess()) { System.debug('SUCCESS: Multi-Root Policy Renewal completed successfully!'); Object outputValue = result.getOutputParameters().get('jobIdentifier'); if (outputValue != null) { System.debug('Job Identifier: ' + outputValue); } else { System.debug('Multi-Root Policy Renewal job started - result: ' + result.getOutputParameters()); } } else { System.debug('ERROR: Multi-Root Policy Renewal failed'); System.debug('Error Details: ' + result.getErrors()); } } } catch (Exception e) { System.debug('EXCEPTION in Multi-Root Policy Renewal Invocable Action: ' + e.getMessage()); System.debug('Stack Trace: ' + e.getStackTraceString()); } } } /\* \* USAGE EXAMPLE: \* Copy and paste this code into Developer Console Execute Anonymous Window \*/ Map params = new Map(); params.put('contextId', ); // REQUIRED params.put('policyId', ); // REQUIRED params.put('policyName', 'Renewed Multi-Root Policy'); params.put('effectiveFromDate', '2026-01-01'); params.put('effectiveToDate', '2027-01-01'); params.put('transactionName', 'Multi-Root Annual Renewal with Updates'); // Build additional fields configuration Map> additionalFields = new Map>(); // Configuration for AutoSilver instance Map autoFields = new Map(); autoFields.put('PolicyName', 'James Auto Policy'); autoFields.put('Name', 'James Auto Policy'); additionalFields.put(, autoFields); // Configuration for FamilyHealth instance Map healthFields = new Map(); healthFields.put('PolicyName', 'James Medical Policy'); healthFields.put('Name', 'James Medical Policy'); additionalFields.put(, healthFields); params.put('additionalFields', additionalFields); MultiRootPolicyRenewalInvocable.executeMultiRootRenewal(params); This sample response is for the Renew Multi-Root Insurance Policy action. \[ { "actionName": "renewMultiRootInsurancePolicy", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "jobIdentifier": "XYTSG000000PgX74AK" }, "sortOrder": -1, "version": 1 } \] # Renew Multi-Root Policy Renew a multi-root policy to create a new policy term for the parent policy and all associated child policies. The parent–child policy structure is preserved in the renewed term. Make sure you have these details before renewing a multi-root policy: - The Policy ID of the active parent insurance policy to be renewed. - The Pricebook ID required to generate the renewal quote. 1. Get Policy Context—Retrieve the policy context by using the policy ID through one of the following methods: - Make a GET request to the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm) Connect API. - Use the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm) invocable action. Returns the context required to generate the renewal quote. 2. Create Renewal Quote—Use the policy context to create the renewal quote by using one of the following methods: - Make a POST request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) Connect API. - Use the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm) invocable action and specify the contextId and pricebookId. Creates a renewal quote associated with the active policy. 3. Modify Renewal Quote (Optional)—Configure changes to the renewal terms by making a PATCH request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm) Connect API with the desired updates. ![Note](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/images/icon_note.png) #### Note For multi-root policies, ensure pricing is recalculated across all root products to accurately compute aggregate totals and prorated term premiums. 4. Renew Multi-Root Policy—Use the updated context to renew the policy by using one of the following methods: - Make a POST request to the [Multi-Root Policy Renewal](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_multi_root_renew.htm) Connect API. - Use the [Renew Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_multi_root_insurance_policy.htm) invocable action. - Returns an Async Request ID in the response to track the job status. - Creates a new parent policy record and corresponding child policy records for the new term. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. - Consolidates financial details at the parent policy level. # Renew Multi-Root Policy Creates a new policy term for a multi-root policy when pricing is handled through the Rating API instead of a quote. This process bypasses the creation of a quote record while generating new parent and child policy records for the renewed term. Make sure you have these details before renewing a multi-root policy: - The Policy ID of the active parent insurance policy to be renewed. 1. Get Policy Context—Retrieve the policy context by using the policy ID through one of the following methods: - Make a GET request to the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm) Connect API. - Use the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm) invocable action. Returns the context required to price and renew the policy. 2. Generate Price-Adjusted Context—Generate a priced context for the new term by making a PATCH request to the [Insurance Product Rating](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API using the context ID. Returns a price-adjusted context that contains the premium calculation for the renewed term. 3. (Optional) Run Qualification Rules—Determine eligibility for renewal by making a POST request to the [CreateUpdateQuote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm) Connect API with saveQuote=false. Returns an updated context containing eligibility results without saving a Quote record. 4. Renew Multi-Root Policy—Use the updated context to renew the policy by using one of the following methods: - Make a POST request to the [Renew Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_multi_root_renew.htm) Connect API. - Use the [Renew Multi-Root Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_multi_root_insurance_policy.htm) invocable action. - Returns an Async Request ID in the response to track the job status. - Creates new parent and child policy records asynchronously for the new term. - Creates a corresponding transaction record for each child policy. In addition, creates a parent policy transaction that represents the rolled-up premium from all associated child policy transactions. - Creates transaction records associated with the renewed policy term. # Renew Policy Policy renewal is the process of extending insurance coverage for an additional policy term, typically as the current policy approaches its effective-to date. A key part of renewal is that a renewed policy creates a new policy record. Make sure you have these details. - Policy ID of the active insurance policy that’s to be renewed. - Pricebook ID as it's a required input for generating an endorsement quote. If the policyholder changes their information, it affects the terms or prices of the renewed policy. This journey describes renewing a policy where a formal renewal quote is generated. After the customer confirms the renewal quote, a new policy record is created for the new renewal term. This diagram outlines the sequence of renewing an existing policy. ![A flow diagram representing the sequence of renewing a policy.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/renew_policy_with_quote.png) 1. **Get Policy Context**—Use the policy ID to get the context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Create Renewal Quote**—Use the policy context to create a renewal quote either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Specify the pricebookId during the API call. You can change the header-level fields of the quote, such as the quote name or the start date of the renewal term by specifying these values as the input parameters during the API call. A new quote record is generated for the policy renewal. After the customer confirms the updated quote price, proceed with the next steps in the renewal workflow. 3. **(Optional)Modify Renewal Quote**—If policyholders want to modify the endorsement quote, make a PATCH request on the [Insurance Quote Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm "HTML (New Window)") Connect API with the desired changes. An updated, price-adjusted context is returned in the response. 4. **Renew Policy**—Use the retrieved context to create a new policy record for the renewal term either by: - Making a POST request on the [Renew Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_renew_policy.htm "HTML (New Window)") Connect API, or - Using the [Renew Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_insurance_policy.htm "HTML (New Window)") invocable action. You can change or confirm the policy name, policy number, and effective start and end dates for the renewed policy directly during the API call. Additionally, you can also specify a name for the transaction record that's created along with the renewal record. This transaction record captures the financial details or the audit information related to the renewal record. **Expected Results:** - A brand new policy record is created in Salesforce, representing the coverage for the new policy term. The new policy record includes the details, such as any changed terms, coverages, prices, and the new start and end dates. - A transaction record is created and linked to the new policy. # Renew Policy Policy renewal extends insurance coverage for an additional term, creating a new policy record. This journey details renewing a policy without using Salesforce quoting, relying on the Rating API for pricing the new term. Make sure you have a valid policy ID of the active insurance policy that's due for renewal. Use the Rating API to generate a price-adjusted context. This price-adjusted context contains the calculated premium and other relevant details that are required to renew the policy. This process bypasses the need for a formal Salesforce Quote record for pricing. This diagram outlines the sequence of renewing a policy, where any changes are initially processed through the Rating API to generate a price-adjusted context. The context contains the calculated premium and other relevant details that are required to renew the policy. This process bypasses the need for a formal Salesforce Quote record for pricing. ![A flow diagram representing the sequence of renewing a policy by using the Rating API.](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/dev_guides/insurance/images/renew_policy_without_quote.png) 1. **Get Policy Context**—Use the policy ID to get the policy context either by: - Making a GET request on the [Insurance Policy Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm "HTML (New Window)") Connect API, or - Using the [Get Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_insurance_policy.htm "HTML (New Window)") invocable action. 2. **Generate Price-adjusted Context**—Make a PATCH request on the [Insurance Product Ratings](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm) Connect API. The price-adjusted context record contains the premium impact of the proposed modifications. 3. **(Optional)Run Qualification Rules**—If customers want to determine the policyholder’s eligibility for a product, run the qualification rules either by: - Making a POST request on the [Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm "HTML (New Window)") Connect API, or - Using the [Create Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_create_quote.htm "HTML (New Window)") invocable action. Set the saveQuote parameter to false. It doesn't save the quote and returns an updated context with the eligibility details. 4. **Renew Policy**—Use the retrieved context to create a new policy record for the renewal term either by: - Making a POST request on the [Renew Insurance Policy](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_renew_policy.htm "HTML (New Window)") Connect API, or - Using the [Renew Insurance Policy Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_renew_insurance_policy.htm "HTML (New Window)") invocable action. You can change or confirm the policy name, policy number, and effective start and end dates for the renewed policy directly during the API call. Additionally, you can also specify a name for the transaction record that's created along with the renewal record. This transaction record captures the financial details or the audit information related to the renewal record. **Expected Results:** - A brand new policy record is created in Salesforce, representing the coverage for the new policy term. The new policy record includes the details, such as any changed terms, coverages, prices, and the new start and end dates. - A transaction record is created and linked to the new policy. # Renew Policy (POST) Renew policy for the specified insurance policy ID. ## Resource {policyId} is a placeholder. /connect/insurance/brokerage/policies/{policyId}/renew ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. {policyId} is a placeholder. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/brokerage/policies/{policyId}/renew ## Available Version 63.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "fieldValueMap": { "Name": "demo" } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | fieldValueMap | Object | JSON object that contains name-value pairs that store details of insurance policy. | Required | 63.0 | ## Response Body for POST [Insurance Policy Process](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_process_output.htm "Output representation details of the renewed policy.") # Renew Policy Input Input representation of the details to renew an insurance policy. ## JSON Example { "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3", "insurancePolicy": { "policyName": "Demo Test Policy 9", "policyNumber": "test renew policy", "effectiveFromDate": "2025-03-15", "effectiveToDate": "2026-03-15" }, "transactionRecord":{ "name": "Renew Payment" }, "billingRecord": { "billDayOfMonth": 15, "billToContact": "003xx000000001aEAA" }, "additionalFields":{ "additionalFieldsList":\[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox\_\_c":"true", "Currency\_\_c":123456, "Date\_\_c":"2024-11-30", "DateTime\_\_c":"2024-12-31T01:34:00.000Z", "Email\_\_c":"testuser@sf.com" } } } { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr\_\_c":"233345675676", "Url\_\_c":"https://thisistest.com", "Time\_\_c":"12:05:00.000Z" } } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm "Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap.")\[\] | JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields. | Optional | 63.0 | | billingRecord | [Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm "Input representation for insurance policy billing.") | Billing details to calculate billing when renewing the policy. | Optional | 67.0 | | contextId | String | Priced context ID of the policy or quote that's used to renew the policy. | Required | 63.0 | | insurancePolicy | [Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm "Input representation of insurance policy details.")\[\] | JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object. | Optional | 63.0 | | transactionRecord | [Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm "Input representation of the insurance policy transaction details.")\[\] | JSON structure that's used to override the transaction information. | Optional | 63.0 | # renewInsurancePolicy(insurancePolicyProcessInput, policyId) Renew policy for the specified insurance policy ID. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.InsurancePolicyProcessOutputRepresentation renewInsurancePolicy(ConnectApi.InsurancePolicyRenewInputRepresentation insurancePolicyProcessInput, String policyId) ## Parameters **insurancePolicyProcessInput** - Type: [ConnectApi.InsurancePolicyRenewInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_insurance_policy_renew.htm "Input representation details of the resource to renew an insurance policy.") - Input representation details of the request to renew an insurance policy. **policyId** - Type: String - ID of the insurance policy that's to be renewed. ## Return Value Type: [ConnectApi.InsurancePolicyProcessOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_insurance_policy_process_output.htm "Output representation details of the insurance policy renewal resource.") ## Usage The Insurance Policy Renewal API takes a JSON input that contains the insurance policy ID that must be renewed along with the fieldValueMap details. The API submits the request to a queue, creates a policy, along with child records by using the context definition selected in setup. The service also overrides the fieldValueMap in the new policy for the policy ID passed in the request. Users receive success and failure notifications on request completion. Keep these considerations in mind when you use this method. - The RenewedFromPolicyId value of the new policy is set to the current policy ID and IsRenewedPolicy field of the new policy is set to true. - The fieldValueMap expects the keys to be API name and is case-sensitive. ## Example The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.renewInsurancePolicy() method to reinstate a previously canceled insurance policy. **Class Definition** This Apex example shows how to renew an insurance policy. global class RenewConnectDriver { global static void callRenewConnectAPI() { Map input = new Map(); input.put('policyId', '0YTxx000000001dGAA'); ConnectApi.InsurancePolicyRenewInputRepresentation policyInput = new ConnectApi.InsurancePolicyRenewInputRepresentation(); Map fields = new Map(); fields.put('Name', 'Test Apex Renew'); policyInput.fieldValueMap = fields; policyInput.sameCarrier = true; input.put('policyInput', policyInput); Map output = new Map(); Map args = new Map(); args.put('input', input); args.put('output', output); RenewTestConnectAPI callable = new RenewTestConnectAPI(); Object result = callable.call('renew', args); ConnectApi.InsurancePolicyProcessOutputRepresentation policyData = (ConnectApi.InsurancePolicyProcessOutputRepresentation) result; System.debug('Renew Policy Data: ' + JSON.serializePretty(policyData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } } } **Usage Example** Use the RenewTestConnectAPI class to execute the renew action and process the result. public class RenewTestConnectAPI implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'renew') { ConnectApi.InsurancePolicyRenewInputRepresentation policyInput = (ConnectApi.InsurancePolicyRenewInputRepresentation) inputMap.get('policyInput'); String policyId = (String) inputMap.get('policyId'); System.debug('Start of Connect API call to renew policy: ' + policyId); ConnectApi.InsurancePolicyProcessOutputRepresentation policyData; try { policyData = ConnectApi.InsuranceBrokerageFamily.renewInsurancePolicy(policyInput, policyId); System.debug('Policy renewed successfully: ' + policyData); outputMap.put('policyData', policyData); } catch (Exception e) { System.debug('Error while renewing policy: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return policyData; } return null; } } // Execute RenewConnectDriver.callRenewConnectAPI(); # RenewPolicy(RenewPolicyInput, policyId) Use the context ID of an existing policy to renew a policy. Modify the renewal date, and add optional fields and additional information in the input JSON. ## API Version 63.0 ## Requires Chatter No ## Signature public static ConnectApi.PolicyOutputRepresentation RenewPolicy(ConnectApi.RenewPolicyInputRepresentation RenewPolicyInput, String policyId) ## Parameters **RenewPolicyInput** - Type: [ConnectApi.RenewPolicyInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_renew_policy.htm "Input representation of the request to renew a policy.") - Input representation of the request to renew a policy. **policyId** - Type: String - ID of the insurance policy that's to be renewed. ## Return Value Type: [ConnectApi.PolicyOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_policy_output.htm "Output representation of the policy details.") # Reprice Insurance Product Action Recalculate the price of insurance products based on user inputs. This action is available in API version 63.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/repriceInsuranceProduct Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: GET, POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | addedNodes | String | Product instances details that are added. | | additionalFields | String | Map of additional fields that must be updated in the insurance quote context. | | contextId | String | Required. Context ID of the Insurance quote. | | deletedNodes | String | Set of deleted product instances details. | | effectiveDate | Date | Date that the quote becomes effective. | | executeRating | String | Indicates whether rating must be executed ( true ) or not ( false ). The default value is true . | | executeConfigurationRules | Boolean | Indicates whether configuration rules must be executed ( true ) or not ( false ). The default value is false . | | pricingProcedureApiName | String | API name of the pricing procedure that's used to price the product. This property is deprecated from version 66.0 and later. | | ratingDate | Date | Date that's used to find the active pricing procedure. | | returnContextJson | Date | Indicates whether context JSON must be returned ( true ) or not ( false ). The default value is false . | | returnProductDetails | Date | Indicates whether product details must be returned ( true ) or not ( false ). The default value is false . | | returnRatingResults | Date | Indicates whether rating results must be returned as an Apex class ( true ) or not ( false ). The default value is false . | | updatedNodes | String | Set of product instances details that are updated. | ## Outputs
Output Details
contextId Type

String

Description

Context ID of the insurance quote.
pricingResults Type

Map<String, Object>

Description

Pricing details of the insurance product that are recalculated.
productRatingOutput Type

Apex-defined

Description

An Apex ConnectApi__ProductRatingOutputRepresentation record that contains the product rating details.
## Example Sample Request { "inputs": \[ { "contextId": "273e01fdfb6f9f21428869eb784ee756976afb0e9bdc49f2a360be397a10ca12", "effectiveDate": "2024-10-18", "addedNodes": "\[{"instanceKeys":\["AutoRoot","AutoBundle","NewDriver"\],"productCode":"autoDriver","attributes":{"DriverAccidents":4},"targetRecords":\["003xx000004WhKhAAK"\]}\]", "returnRatingResults": true, "returnContextJson": true, "returnProductDetails": true } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for repriceInsuranceProduct invocable action public class RepriceInsuranceProductInvoke { private static final String ACTION\_NAME = 'repriceInsuranceProduct'; public static Boolean invokeMethod( Map inputs, Map output, Map options ) { Map patchPayload = (Map) getValueFromMap('patchPayload', inputs, options); System.debug('Rating patch Input: ' + patchPayload); if (patchPayload == null) { output.put('success', false); output.put('errorMessage', 'patchPayload is required for rating patch'); output.put('errorType', 'VALIDATION\_ERROR'); return false; } try { System.debug('Calling Invocable Action: repriceInsuranceProduct'); Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); System.debug('Context Id::::::::' + patchPayload.get('contextId')); action.setInvocationParameter('contextId', patchPayload.get('contextId')); System.debug('Updated Nodes::::::::' + patchPayload.get('updatedNodes')); setInvocationParameter(action, patchPayload, 'updatedNodes', true); System.debug('Added Nodes::::::::' + patchPayload.get('addedNodes')); setInvocationParameter(action, patchPayload, 'addedNodes', true); System.debug('Deleted Nodes::::::::' + patchPayload.get('deletedNodes')); setInvocationParameter(action, patchPayload, 'deletedNodes', true); if (patchPayload.containsKey('executeRating')) { System.debug('Options::::::::' + patchPayload.get('executeRating')); action.setInvocationParameter('executeRating', patchPayload.get('executeRating')); } if (patchPayload.containsKey('executeConfigurationRules')) { System.debug('Options::::::::' + patchPayload.get('executeConfigurationRules')); action.setInvocationParameter('executeConfigurationRules', patchPayload.get('executeConfigurationRules')); } if (patchPayload.containsKey('returnContextJSON')) { System.debug('Options::::::::' + patchPayload.get('returnContextJSON')); action.setInvocationParameter('returnContextJSON', patchPayload.get('returnContextJSON')); } if (patchPayload.containsKey('returnProductDetails')) { System.debug('Options::::::::' + patchPayload.get('returnProductDetails')); action.setInvocationParameter('returnProductDetails', patchPayload.get('returnProductDetails')); } if (patchPayload.containsKey('returnRatingResults')) { System.debug('Options::::::::' + patchPayload.get('returnRatingResults')); action.setInvocationParameter('returnRatingResults', patchPayload.get('returnRatingResults')); } List results = action.invoke(); if (results != null && !results.isEmpty()) { Invocable.Action.Result result = results\[0\]; if (result.isSuccess()) { System.debug('Rating patch successfully via Invocable Action'); output.put('ratingData', result.getOutputParameters()); Map outputParams = result.getOutputParameters(); if (outputParams != null) { if (outputParams.containsKey('contextId')) { output.put('contextId', outputParams.get('contextId')); } if (outputParams.containsKey('contextJSON')) { output.put('contextJSON', outputParams.get('contextJSON')); } if (outputParams.containsKey('pricingResult')) { output.put('pricingResult', outputParams.get('pricingResult')); } if (outputParams.containsKey('productDetails')) { output.put('productDetails', outputParams.get('productDetails')); } System.debug('Rating Patch data extracted: ' + outputParams); } List actionErrors = result.getErrors(); if (actionErrors != null && !actionErrors.isEmpty()) { output.put('success', false); output.put('error', result.getErrors()); return false; } output.put('success', true); return true; } else { List actionErrors = result.getErrors(); String errorMessage = 'Rating Patch Invocable Action failed'; if (actionErrors != null && !actionErrors.isEmpty()) { List errorMessages = new List(); List> errorDetailsList = new List>(); for (Invocable.Action.Error actionError : actionErrors) { errorMessages.add(actionError.getMessage()); errorDetailsList.add(new Map{ 'message' => actionError.getMessage(), 'code' => actionError.getCode() }); } errorMessage = String.join(errorMessages, '; '); output.put('actionErrors', errorDetailsList); } output.put('success', false); output.put('errorMessage', errorMessage); System.debug(LoggingLevel.ERROR, 'Rating Patch Invocable Action failed: ' + errorMessage); return false; } } else { output.put('success', false); output.put('errorMessage', 'Rating Patch Invocable Action returned null or empty results'); System.debug(LoggingLevel.WARN, 'Rating Patch Invocable Action returned null/empty results'); return false; } } catch (Exception e) { String errorMsg = 'Exception: ' + e.getMessage(); output.put('success', false); output.put('errorMessage', errorMsg); output.put('errorType', 'EXCEPTION'); System.debug(LoggingLevel.ERROR, 'Exception while rating patch: ' + errorMsg); return false; } } private static Object getValueFromMap(String key, Map inputs, Map options) { if (inputs != null && inputs.get(key) != null && String.isNotBlank(String.valueOf(inputs.get(key)))) { return inputs.get(key); } else if (options != null && options.get(key) != null && String.isNotBlank(String.valueOf(options.get(key)))) { return options.get(key); } return null; } private static void setInvocationParameter( Invocable.Action action, Map payload, String inputAttribute, Boolean serializeJSON ) { if (payload.containsKey(inputAttribute) && payload.get(inputAttribute) != null) { System.debug(inputAttribute + ': ' + JSON.serialize(payload.get(inputAttribute))); if (serializeJSON) { action.setInvocationParameter(inputAttribute, JSON.serialize(payload.get(inputAttribute))); } else { action.setInvocationParameter(inputAttribute, payload.get(inputAttribute)); } } else { System.debug('payload does not contain attribute: ' + inputAttribute); } } } Sample Response \[ { "actionName": "repriceInsuranceProduct", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "contextId": "273e01fdfb6f9f21428869eb784ee756976afb0e9bdc49f2a360be397a10ca12", "productRatingOutput": { "ratingResult": { "childNodes": \[ { "childNodes": \[ { "childNodes": \[ { "childNodes": \[\], "details": { "NetUnitPrice": null, "InstanceKey": "Driver", "ProductCode": "driver", "NetTotalPrice": 0, "Driver\_Accident\_Points": 15, "ProratedQLITaxAmount": 0, "Driver\_MVR\_Points": 8, "Age\_First\_Licensed": 16 } }, { "childNodes": \[\], "details": { "NetUnitPrice": 501.84, "InstanceKey": "Comprehensive", "ProductCode": "comprehensive", "NetTotalPrice": 501.84, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 501.84, "InstanceKey": "Auto1", "ProductCode": "auto", "NetTotalPrice": 501.84, "ProratedQLITaxAmount": 0 } } \], "details": { "NetUnitPrice": 1485.84, "InstanceKey": "AutoSilver", "ProductCode": "autoSilver", "NetTotalPrice": 1485.84, "ProratedQLITaxAmount": 0 } } \], "details": {} }, "productDetails": \[ { "productSpecificationType": { "productSpecificationRecordType": {}, "name": "InsuredParty" }, "childProducts": \[\], "additionalFields": { "ProductCode": "driver", "SpecificationType": "InsuredParty", "BasedOnId": "11Bxx000002C1kZEAS", "Name": "Driver" }, "availabilityDate": null, "description": null, "productInformation": null, "childVariationIds": \[\], "isActive": true, "qualificationContext": null, "productClassification": { "id": "11Bxx000002C1kZEAS" }, "productComponentGroups": \[\], "configureDuringSale": "Allowed", "productRelatedComponent": null, "id": "01txx0000006i3iAAA", "prices": \[\], "isComponentRequired": null, "productType": null, "isAssetizable": true, "isSoldOnlyWithOtherProds": false, "attributeCategories": \[ { "code": "Driving History", "records": \[ { "isRequired": false, "code": "AgeFirstLicensed", "additionalFields": {}, "attributeCategoryId": "0v3xx0000000001AAA", "hidden": false, "isConfigurable": false, "dataType": "NUMBER", "label": "Age First Licensed", "isReadOnly": false, "isCloneable": false, "name": "Age First Licensed", "id": "0tjxx000000001FAAQ", "attributeNameOverride": "Age First Licensed", "isPriceImpacting": true, "developerName": "Age\_First\_Licensed", "status": "Active" } \], "name": "Driving History" } \], "nodeType": "simpleProduct", "displayUrl": null, "productSellingModelOptions": \[ { "productSellingModel": { "sellingModelType": "OneTime", "name": "One Time", "id": "0jPxx0000000001EAA", "doesAutoRenewByDefault": false, "status": "Active" }, "productSellingModelId": "0jPxx0000000001EAA", "isDefault": true, "productId": "01txx0000006i3iAAA", "id": "0iOxx000000000zEAA" } \], "productQuantity": null, "productCode": "driver", "name": "Driver" } \], "contextJSON": { "salesTransactions": \[ { "salesTransactionItems": \[ { "salesTransactionItemClauses": \[\], "childNodes": \[ { "salesTransactionItemClauses": \[\], "childNodes": \[\], "salesTransactionItemAttributes": \[ { "fields": { "AttributeKey": "0tjxx000000000PAAQ", "AttributeValue": "50", "ParentReference": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "hasObjectRef": null, "AttributePicklistValue": "0v6xx000000000ZAAQ", "IsPriceImpacting": false, "businessObjectType": "QuoteLineItemAttribute", "AttributeName": "Deductible", "AttributeDefinitionCode": "Deductible", "id": "ref\_fdd78e30\_1258\_4ea3\_9f56\_c74245ae58d6", "SalesTransactionItemAttrParent": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "AttributeDeveloperName": "Deductible" } } \] } \], "salesTransactionItemRelatedObjects": \[\], "salesTransactionItemTaxes": \[\], "fields": { "LevelTwoBasePremium": 120, "IntermediateVariableTwo": null, "Product": "01txx0000006i3UAAQ", "businessObjectType": "QuoteLineItem", "DYN\_\_License\_State": null, "RevenueCloudPackagingFlag": "C", "ValidationResult": null, "DYN\_\_AssetRecordName": null, "PolicyPremium": 1485.84, "PeriodBoundaryStartMonth": null, "SalesTransactionSourceAsset": null, "ProratedQLITaxAmount": 0, "id": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "TaxTreatment": null, "Subtotal": null, "LineItemPath": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc/ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "DiscountAmount": null, "PricebookEntry": null, "NetUnitPrice": 590.4, "ParentSalesTransactionItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "ObligatedAmount": null, "DYN\_\_Age\_First\_Licensed": null, "LevelThreePremium": null, "ProductName": "Bodily Injury & Property Damage", "ProformaBillingPeriodAmount": null, "CommissionAmount": null, "ProductSpec": "Coverage", "DYN\_\_Last\_Name": null, "PricingTermCount": null, "DYN\_\_ContactRecordName": null, "RoundedLineAmount": null, "SalesTransactionAction": null, "TransactionType": null, "PricingTermUnit": null, "BasisTransactionItem": null, "PricingSource": null, "StockKeepingUnit": null, "DYN\_\_Year": null, "PartnerUnitPrice": null, "ItemTotalAdjustmentAmount": null, "ArePartialPeriodsAllowed": false, "DYN\_\_Bodily\_Injury\_Per\_Person\_Limit": 1000, "DYN\_\_Colour": null, "FactorP": null, "FactorO": null, "CustomProductName": null, "SalesTransactionItemParent": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "Quantity": 1, "ContractId": null, "ItemGroupSummarySubtotal": null, "DYN\_\_AccountRecordName": null, "DYN\_\_E\_Mail": null, "DYN\_\_First\_Name": null, "DYN\_\_Bodily\_Injury\_Per\_Accident\_Limit": 1000, "DYN\_\_Driver\_Accident\_Points": null, "SalesItemType": null, "ItemPath": "01txx0000006i3DAAQ/01txx0000006i3UAAQ" }, "salesTransactionItemRelationships": \[ { "fields": { "ParentReference": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "AssociatedItem": "ref\_681c203e\_5491\_4d5f\_a296\_02a0b3dfa181", "MainItemRole": null, "ProductRelatedComponent": "0dSxx000000000XEAQ", "businessObjectType": "QuoteLineRelationship", "AssociatedItemPricing": "IncludedInBundlePrice", "ProductRelationshipType": "0yoxx0000000001AAA", "RootItemProductCode": "autoSilver", "IsPriceInclusive": true, "RootItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "RootItemProductSellingModel": null, "AssociatedQuantScaleMethod": null, "MainItem": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "AssociatedItemRole": null, "SalesTrnItemRelationshipParent": null, "id": "ref\_80623cb4\_3abd\_4ee0\_876a\_c5ca9ecc07fc", "MainItemProduct": "01txx0000006i3DAAQ", "MainItemProductSellingModel": null, "RootItemProduct": "01txx0000006i3DAAQ" } } \] } \], "salesTransactionItemAttributes": \[\], "salesTransactionItemRelatedObjects": \[\], "salesTransactionItemTaxes": \[\], "fields": { "LevelTwoBasePremium": null, "IntermediateVariableTwo": null, "Product": "01txx0000006i3DAAQ", "businessObjectType": "QuoteLineItem", "DYN\_\_License\_State": null, "RevenueCloudPackagingFlag": "C", "ValidationResult": null, "DYN\_\_AssetRecordName": null, "PolicyPremium": 1485.84, "PeriodBoundaryStartMonth": null, "SalesTransactionSourceAsset": null, "ProratedQLITaxAmount": 0, "id": "ref\_e112c127\_367c\_41c8\_a5ce\_1d7e69ac58bc", "DYN\_\_Age": null, "DYN\_\_Property\_Damage\_Per\_Accident\_Limit": null, "DYN\_\_Deductible": null, "STICurrencyIsoCode\_\_std": null, "IntermediateVariableOne": null, "BillingFrequency": null, "DYN\_\_State": null, "DYN\_\_DOB": null, "ProductCode": "autoSilver", "DerivedPricingAttribute": false, "ItemPath": "01txx0000006i3DAAQ" }, "salesTransactionItemRelationships": \[\] } \], "fields": { "Account": null, "BillingCity": null, "businessObjectType": "Quote", "SalesTransactionName": null, "StatusCode": null, "ProratedAmount": 1485.84, "StartDate": "2025-11-04", "CurrencyIsoCode\_\_std": null, "BillingPostalCode": null, "id": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "BillingState": null, "CensusRatingType\_\_std": null, "TransactionType": "AutoTransactionType", "UserProfile": "System Administrator", "QuoteAccount": null, "TotalProratedAmount": 1485.84, "CensusType\_\_std": null, "GroupCensus": null, "SalesTransactionType": null, "Pricebook": null, "Opportunity": null, "ShippingCountry": null, "ShippingCity": null, "StandardAmount": 1485.84, "ProratedTaxAmount": 0, "RatingDate": null, "SalesTransactionSource": "ref\_ed3d9643\_12e4\_4709\_9f74\_69c8292d65b4", "EffectiveDate": "2025-11-04T00:00:00.000Z", "TotalStandardAmount": 1485.84 }, "appUsageAssignments": \[\] } } }, "sortOrder": -1, "version": 1 } \] # Requests Learn about the available Insurance Brokerage API requests. - **[Cost Calculation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_cost_calculation_input.htm)** Input representation of the request to calculate brokerage cost. - **[Expected Revenue Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_expected_revenue_input.htm)** Input representation of the request to calculate expected brokerage revenue. - **[Insurance Commission Processing Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_commission_processing_input.htm)** Input representation details of insurance commission processing. - **[Insurance Billing Schedules Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_billing_input.htm)** Details for creating billing schedules from an insurance transaction. - **[Insurance Policy Bulk Field Map Input Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_bulk_field_map_input.htm)** Input representation for Insurance Policy Bulk lifecycle process APIs with per-policy field value maps. - **[Insurance Policy Bulk Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_bulk_input.htm)** Input representation for bulk policy operations. Specify the list of insurance policy IDs and field value map of insurance policy fields for bulk operations. - **[Insurance Policy Cancellation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_cancellation_input.htm)** Send the cancellation details to cancel an insurance policy, including the effective date, reason, and target status. - **[Insurance Policy Draft Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_draft_input.htm)** Send the field value map of insurance policy fields to create a draft endorsement for the specified policy. - **[Insurance Policy Reinstatement Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_reinstatement_input.htm)** Send the reinstatement details to reinstate a canceled insurance policy, including the reinstatement date and any policy field overrides. - **[Insurance Policy Renew Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_renew_input.htm)** Input representation of the details of the request to renew policy. - **[Plan Benefit Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_attribute_input.htm)** Represents details of the plan benefits attributes for an Insurance Policy Coverage. - **[Plan Benefit Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_input.htm)** Represents details of the plan benefits for an Insurance Policy Coverage. - **[Plan Benefit Update Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_update_input.htm)** Represents details of the plan benefits for an Insurance Policy Coverage. - **[Premium Preview Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_premium_preview_input.htm)** Input representation of the policy-hierarchy nodes to include in a draft-state premium preview. Omit or leave empty to return only the policy-level (root) rolled-up amounts. - **[Premium Preview Reference Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_premium_preview_reference.htm)** Input representation of a node within the insurance policy hierarchy whose rolled-up premium amounts you want to compute. - **[Networks Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefit_network.htm)** Represents Insurance Policy Coverage Networks for creating plan benefits. - **[Update Plan Benefit Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_plan_benefits_input.htm)** Update Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits by using the ID of an Insurance Policy Coverage. # Requests Learn more about the available requests of insurance claim APIs. - **[Bulk Pay Claim Coverage Payment Details Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_bulk_pay_claim_cvr_payment_detail_input.htm)** Input representation of the details for the bulk pay CCPD resource. - **[Calculate Adjustments Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_calculate_adjustments_input.htm)** Input representation for calculating adjustments for the claim loss item. - **[Claim Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_attribute_input.htm)** Input representation for claim attributes. - **[Claim Coverage Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_create_claim_coverage_input.htm)** Input representation for creating a claim coverage. - **[Claim Coverage Update Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_update_claim_coverage_input.htm)** Input representation for updating a claim coverage. - **[Claim Coverage Payment Detail Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_create_claim_cov_payment_detail_input_rep.htm)** Input representation for creating a claim coverage payment detail record. - **[Claim Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_input.htm)** Input representation for creating or updating a claim. - **[Claim Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_item_input.htm)** Input representation for a claim item. - **[Claim Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_options_input.htm)** Input representation for claim options. - **[Claim Participant Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_participant_input.htm)** Input representation for a claim participant. - **[Claim Related Object Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_claim_related_object_input.htm)** Input representation for a related object on a claim. - **[Edit Claim Coverage Payment Detail Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_edit_claim_cvr_payment_detail_input.htm)** Details to edit a claim coverage payment detail record. - **[Generate Policy Limits Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_create_policy_limits_input.htm)** Input representation for creating insurance policy limit records. - **[Insurance Policy Limit Current Standings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_policy_lmt_current_standings_input.htm)** Input representation for the current standings of the insurance policy limits. - **[Limit Standing Option Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_limit_standing_option_input.htm)** Input representation for limit standing options. - **[Pay Claim Coverage Payment Detail Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_input.htm)** Input representation for paying a claim coverage payment detail. - **[Pay Claim Coverage Payment Detail Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_claim_coverage_payment_detail_options_input.htm)** Input representation of the options to control which pre-payment check to run for a claim coverage payment detail. - **[Pay Ex Gratia Claim Coverage Payment Detail Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_pay_ex_gratia_claim_cvr_payment_detail_input.htm)** Input representation for the ex gratia payment for the claim coverage payment detail. - **[Process Policy Limits Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_process_policy_limits_input.htm)** Input representation for processing policy limits for a claim loss item. - **[Recalculate Adjustments Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_recalculate_adjustments_input.htm)** Input representation for recalculating the adjustments for existing payment details. - **[Verify Policy Coverage Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_verify_policy_coverage_input.htm)** Input representation of a policy coverage's applicability for a specified loss date under an insurance policy. # Requests Learn about the available Insurance Design Advisor API requests. - **[Insurance Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_attribute_input.htm)** Input representation of one attribute definition to validate. Specify at least one of attribute ID, attribute code, or developer name. - **[Insurance Attribute Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_attribute_validation_input.htm)** Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name. - **[Insurance CML Model Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_cml_model_validation_input.htm)** Input representation of the insurance products and related records to validate against the active CML model. - **[Insurance Get Rating Input Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_get_rating_input_input.htm)** Input representation that specifies the product for which to generate a sample rating input payload. - **[Insurance Lookup Error Code Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_lookup_error_code_input.htm)** Input representation that specifies the insurance error code to look up. - **[Insurance Pricing Setup Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_pricing_setup_validation_input.htm)** Input representation of the quote, transaction type, and products to validate for pricing setup configuration. - **[Insurance Product Discovery Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_product_discovery_validation_input.htm)** Input representation of the product to validate for discovery setup. Identify the product by ID, product code, or developer name. - **[Insurance Product Model Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_product_model_validation_input.htm)** Input representation of the details to validate an insurance product model. - **[Insurance Request Validation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_request_validation_input.htm)** Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model. - **[Insurance Validate User Permissions Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_validate_user_permissions_input.htm)** Input representation that specifies the insurance operation and optional user ID for a permissions check. # Requests Learn more about the available requests of insurance group benefits APIs. - **[Insurance Person Accounts and Users Creation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_accounts_and_users_creation_input.htm)** Input representation for creating person accounts and portal users from group census members. - **[Portal User Creation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_portal_user_creation_input.htm)** Input representation for the details to create a portal user. - **[Insurance Member Rating Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_member_rating_input.htm)** Input representation for rating the individual members within a group. - **[Insurance Member Rating Details Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_member_rating_details_input.htm)** Input representation for an individual member to be rated. - **[Insurance Member Rating Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_member_rating_plans_input.htm)** Input representation for an individual rating plan. - **[Insurance Contacts and Users Creation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contacts_and_users_creation_input.htm)** Input representation for creating contacts and portal users from group census members. - **[Bulk Group Census Management Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_bulk_census_mgmt_input.htm)** Input representation to bulk-process group census data from a CSV file. - **[Insurance Group Census Member Management Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_mgmt_input.htm)** Input representation for the details to add or update group census members. - **[Group Census Member Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_member_input.htm)** Input representation for the details of the group census member. - **[Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_additional_fields_map_value.htm)** Input representation for additional fields map value. - **[Insurance Update Member Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_update_member_plans_input.htm)** Input representation for updating the plans that are associated with a census member. - **[Insurance Add Member Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_add_member_plans_input.htm)** Input representation for adding plans to a census member. Use contractGroupPlanId to add standard plans defined in the group's contract, with the option to include attributes for granular overrides. Alternatively, use productCode and contractGroupPlanId to add off-contract coverages. When adding off-contract coverages, you can use the attributes parameter to define specific coverage details. productCode and contractGroupPlanId are mutually exclusive. You must provide one or the other based on whether the coverage is standard or off-contract. - **[Group Census Member Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_member_plan_input.htm)** Input representation for a single plan or coverage for a group census member. - **[Group Census Deep Clone Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_deep_clone_input.htm)** Input representation of the details to clone a group census hierarchy, including optional filters, reference mappings, field overrides, and a custom context definition. - **[Group Census Field Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_field_mapping_input.htm)** Input representation of the filters and reference mapping rules used to remap fields on an existing group census in place, without creating new records. - **[Group Census Filters Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_filters_input.htm)** Input representation of the per-entity filters that scope which group census member plan records are processed. - **[Group Census Reference Mappings Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_group_census_reference_mappings_input.htm)** Input representation of the per-entity reference values saved to group census member plan records. - **[Member Plan Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_filter_input.htm)** Input representation of the filter that identifies which group census member plan records to process. - **[Member Plan Reference Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_reference_mapping_input.htm)** Input representation of the reference mapping applied to group census member plan records, such as mapping a quote line item to a contract group plan or the reverse. - **[Members With Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_members_with_plans_input.htm)** Input representation of a family of group census members and their plans to add or update, including optional duplicate-detection fields, a processing flow, and configuration-rule settings. - **[Member With Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_with_plans_input.htm)** Input representation of a group census member and the insurance plans to add or update for that member. - **[Member Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_plan_input.htm)** Input representation of an insurance plan to add or update for a group census member. - **[Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_attribute_input.htm)** Input representation of an overridden attribute value on a group census member plan. - **[Member Overrides Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_overrides_input.htm)** Input representation of the member overrides to upsert or clone on a root quote line item, including an optional context ID and target member IDs for clone operations. - **[Member Override Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_member_override_input.htm)** Input representation of a single member override, including the member, product or quote line item, operation, and any overridden attributes. - **[Override Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_override_attribute_input.htm)** Input representation of an attribute value to apply when you override a plan or coverage for a group census member. - **[Insurance Group Endorsement Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_endorsement_input.htm)** Input representation of the optional flow and repricing settings that are used to apply mid-term contract adjustments to member policies in a group census. - **[Insurance Group Adjustment Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_adjustment_input.htm)** Input representation of the optional flow and repricing settings used to submit a bulk mid-term adjustment request for a group census. The source group census is supplied as the {censusId} path parameter. - **[Insurance Group Renewal Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_renewal_input.htm)** Input representation of the optional flow and repricing settings used to renew member policies for a group census. - **[Insurance Price Comparison Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_price_comparison_input.htm)** Input representation of the optional filters that scope a price comparison for a group census. Use these settings to narrow the comparison to a product category or to specific members, and to control whether to get the plan and coverage attributes in the response. - **[Delete Member Plans Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_delete_member_plans_input.htm)** Input representation for deleting the insurance plans for a census member. - **[Insurance Plans Eligibility Create Context Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_plans_eligibility_post_input.htm)** Input representation for checking plan eligibility by creating a new context. - **[Insurance Plans Eligibility Update Context Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_plans_eligibility_patch_input.htm)** Input representation for checking plan eligibility by updating an existing context. - **[Insurance Group Plan Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_plan_input.htm)** Input representation for group census member plans and their coverages. - **[Contract Creation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_creation_input.htm)** Input representation for creating group benefits contract. - **[Contract Item](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_contract_item.htm)** Input representation for additional fields to be added to contract items. - **[Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm)** Input representation for a key-value pair. - **[Insurance Create Quote From Contract Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_create_quote_from_contract_input.htm)** Input representation of the details to create a quote from an existing group benefits contract. - **[Insurance Generate Census Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_generate_census_input.htm)** Input representation of the details to generate a group census from the policies on an existing group benefits contract. - **[Update Group Census Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_refresh_census_input.htm)** Input representation of the details to update a group census from policy enrollments and endorsements on an existing group benefits contract. - **[Insurance Generate Refresh Census Members Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_generate_refresh_census_members_input.htm)** Input representation of the details to generate or update group census members from policy information on an existing group benefits contract. - **[Insurance Generate Refresh Census Members Additional Fields Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_generate_refresh_census_members_additional_fields.htm)** Input representation of the additional field values to apply to group census members during a generate or refresh census members operation. - **[Insurance Upsert Member Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_upsert_member.htm)** Input representation of a group census member and the additional field values to apply during an upsert operation. - **[Insurance Census Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_filter_input.htm)** Input representation of the filter criteria that select which policy records to include when generating a group census from a contract. - **[Insurance Quote Configuration Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_gb_quote_config_options.htm)** Input representation of the details to specify whether configuration and qualification rules run when creating a quote from a contract. - **[Insurance Quote Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_item.htm)** Input representation of the details to extend the quote created from a contract. - **[Insurance Issue Contract Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_issue_contract_input.htm)** Input representation of the details, such as the quote ID, contract dates, enrollment window, and optional term and additional fields to use to synchronously issue a group benefits contract from a quote. - **[Insurance Contract Item Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_item.htm)** Input representation of the details, such as object, product path, and field values to extend a contract when issuing it from a quote. - **[Insurance Contract Endorse Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_endorse_input.htm)** Input representation of the details, such as quote ID, endorsement effective date, optional enrollment window, and additional fields to create an endorsed contract version from a quote. - **[Insurance Contract Renewal Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_renewal_input.htm)** Input representation of the details, such as the quote ID, renewal and contract end dates, and optional enrollment window, term, target contract, and additional fields to create a renewed-term contract from a quote. - **[Insurance Contract Transactions Generation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_contract_generate_txn_input.htm)** Input representation of the date range and job name to generate contract transactions for a group benefits contract. - **[Group Rating Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_rating_input.htm)** Input representation for the Group Benefits Group Rating API. - **[Individual Enrollment Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_individual_enrollment_input.htm)** Input representation for individual enrollment. - **[Individual Mid-Term Adjustment Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_individual_mta_input.htm)** Input representation for applying a mid-term adjustment to a group census member's insurance policies. - **[Group Enrollment Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_group_enrollment_input.htm)** Input representation for the Group Enrollment API. Use these properties to label the asynchronous bulk enrollment job and, optionally, to specify a custom flow to run for each member of the census. - **[Insurance Delete Census Member Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_delete_census_mgmt_input.htm)** Input representation to delete census member. # Requests Learn more about the available Insurance Policy requests. - **[Additional Fields Field Set Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_field_set_input.htm)** Input representation for the list of the field set IDs for asset, coverage, participant, and policy objects. - **[Additional Fields Map Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_additional_fields_map_value.htm)** Input representation for the AdditionalFieldsMapValue wrapper object that's used as child wrapper of AdditionalFieldsMap. - **[Cancel Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_cancel_policy_input.htm)** Input Representation of cancel policy details. - **[Endorse Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_endorse_policy_input.htm)** Input representation of endorse policy details. - **[Insurance Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_input.htm)** Input representation of insurance policy details. - **[Insurance Policy Transaction Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_transaction_input.htm)** Input representation of the insurance policy transaction details. - **[Issue Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_issue_policy_input.htm)** Input representation of the request to issue an insurance policy. - **[Out-of-Sequence Endorse Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_out_of_sequence_endorse_policy_input.htm)** Input representation of the details for creating the out-of-sequence endorsement. - **[Reinstate Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_reinstate_policy_input.htm)** Input representation for reinstating an insurance policy. - **[Renew Policy Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_renew_policy_input.htm)** Input representation of the details to renew an insurance policy. - **[Insurance Policy Billing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_policy_billing_info_input.htm)** Input representation for insurance policy billing. # Requests Learn more about the available Insurance Product Administration requests. - **[Evaluation Task Group Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_evaluation_task_group_input.htm)** Input representation details of the evaluation task group. - **[Evaluation Task Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_evaluation_task_input.htm)** Input representation details of the evaluation task. - **[Insurance Create Underwriting Rules Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_create_underwriting_rules_input.htm)** Create Underwriting Rule Input Representation - **[Insurance Rule Condition Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_rule_condition_input.htm)** Input representation details of insurance rule condition. - **[Insurance Rule Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_rule_criteria_input.htm)** Input representation details of the insurance rule criteria. - **[Insurance Underwriting Rule Group Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_underwriting_rule_group_input.htm)** Input representation details of the insurance underwriting rule group. - **[Insurance Underwriting Rule Group Update Status Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_underwriting_rule_group_update_status_input.htm)** Input representation of the request to update insurance underwriting rule group status. - **[Insurance Update Underwriting Rules Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_update_underwriting_rules_input.htm)** Update Underwriting Rule Input Representation # Requests Learn more about the available Insurance Quoting requests. - **[Add Eligible Product Clause Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_add_eligible_product_clauses_input.htm)** Input representation for adding eligible product clauses. - **[Add Eligible Product Clause Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_add_eligible_product_clauses_options_input.htm)** Input representation for options when adding eligible product clauses. - **[Bulk Product Clause Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_bulk_create_product_clause_input.htm)** Input representation for creating one or a list of product clauses. - **[Clause Generation Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_clause_generation_options_input.htm)** Input representation for clause generation options. - **[Product Clause Generation Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_clause_generation_input.htm)** Input representation for generating product clauses. - **[Instance Key Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_instance_key_input.htm)** Input representation for a single instance key array. - **[Insurance Get Eligible Clauses Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_get_eligible_clauses_input.htm)** Input representation for get eligible insurance product clauses. - **[Insurance Product Clause Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_product_clause_input.htm)** Input representation for a single insurance product clause. - **[Insurance Quote Config Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_config_options.htm)** Input representation of insurance quote line item related objects. - **[Insurance Quote Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_options.htm)** Input representation of insurance quote options. - **[Insurance Quote Related Record Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_quote_related_record_input.htm)** Input representation of insurance quote line item related objects. - **[Insurance Invoke Underwriting Rule Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_invoke_underwriting_rule_input.htm)** Input representation for invoke underwriting rule operation. - **[Insurance Quote Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_input_node.htm)** Input representation of root quote line items and child quote line items of insurance quote. - **[Insurance Quote Patch Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_patch_input.htm)** Input representation for insurance quote patch operation. - **[Insurance Quote Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_quote_post_input.htm)** Input representation details to create insurance quote. - **[Product Clause Update Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_update_product_clause_input.htm)** Input representation for updating a product clause. - **[Product Clause Variable Mapping Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_product_clause_variable_mapping_input.htm)** Input representation for mapping an insurance clause variable to an insurance product variable. - **[Product Rating Patch Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_rating_patch_input.htm)** Input representation of product rating update details. - **[Product Rating Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_rating_post_input.htm)** Input representation of the product rating details. - **[Product Rating Request Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_get_rating_details_input.htm)** Input representation for getting rating input from product IDs. - **[Product Surcharge Bulk Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_surcharge_bulk_post_input.htm)** Input representation of the details of the product surcharge records. - **[Product Surcharge Patch Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_surcharge_patch_input.htm)** Input representation for product surcharge patch request. - **[Product Surcharge Post Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_product_surcharge_post_input.htm)** Input representation of product surcharge details. - **[Product Clause Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_create_product_clause_input.htm)** Input representation for the details of a single product clause to be created. - **[Rating Input Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_input_node.htm)** Input representation of details of context node. - **[Rating Options Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_rating_options_input.htm)** Input representation details of rating service options. # Resources Learn about the available Insurance Brokerage API resources. - **[Bulk Cancel Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_cancel_policy.htm)** Cancel policies in bulk for the specified insurance policy IDs. - **[Bulk Endorse Draft Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_endorse_draft_policy.htm)** Create endorsement drafts in bulk for the specified insurance policies. You can modify the drafts until you endorse the policies using the Bulk Endorse Policy API. After you endorse the policies, you can't make any further changes. - **[Bulk Endorse Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_endorse_policy.htm)** Endorse policies in bulk for the specified insurance policy IDs. - **[Bulk Issue Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_issue_policy.htm)** Issue policies in bulk for the specified insurance policy IDs. - **[Bulk Reinstate Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_reinstate_policy.htm)** Reinstate policies in bulk for the specified insurance policy IDs. - **[Bulk Renew Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_bulk_renew_policy.htm)** Renew policies in bulk for the specified insurance policy IDs. - **[Cancel Policy (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_cancel_policy.htm)** Cancel an insurance policy. - **[Commission Processing (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_commission_processing.htm)** Process commission statements in an asynchronous manner using a preconfigured batch job. - **[Cost Calculation (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cost_calculation.htm)** Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. The InsuranceRatePlanLineItem premium, fees, or premium equivalent amount is rolled up to the Insurance Rate Plan, Insurance Coverage, and Insurance Policy Premium Amount. - **[Endorse Policy (POST, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_endorse_policy.htm)** Create an endorsement policy draft or complete endorsing a policy by using the insurance policy ID. - **[Expected Revenue (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_expected_revenue.htm)** Calculate the expected revenue, derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. The expected revenue amount is rolled up from Insurance Rate Plan to Insurance Coverage and Insurance Policy expected revenue amount. - **[Insurance Billing Schedules (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_billing.htm)** Create billing schedules from insurance policy transactions to generate financial records for policy lifecycle events. - **[Issue Policy (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_issue_policy.htm)** Issue a policy using the policy ID. - **[Preview Policy Premium (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_policy_premium_preview.htm)** Preview prorated and rolled-up premium amounts for draft insurance policy hierarchy without creating or updating the changes. - **[Plan Benefits (GET, POST, PATCH, DELETE)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_plan_benefits.htm)** Get, create, update and delete Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits of an Insurance Policy Coverage. - **[Plan Benefits Product Model (GET)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_plan_benefits_product_model.htm)** Get the product model details along with child components and their attributes for a given insurance policy coverage. - **[Reinstate Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_reinstate_policy.htm)** Reinstate a canceled policy for the specified insurance policy ID. - **[Renew Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_brokerage_renew_policy.htm)** Renew policy for the specified insurance policy ID. # Resources Learn more about the available Insurance Claims API. - **[Bulk Pay Claim Coverage Payment Details (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_bulk_pay_claim_coverage_payment_detail.htm)** Initiate asynchronous payment processing for claim coverage payment detail records in bulk. Specify the claim coverage payment detail IDs you want to process for payment, and the API validates access, enqueues work, and returns an identifier you can use to track the bulk job. - **[Calculate or Recalculate Adjustments (POST, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_calculate_adjustments.htm)** Calculate adjustments for a new loss item (POST) or recalculate adjustments for an existing payment detail record (PATCH) under a claim coverage. - **[Cancel Claim Coverage Payment Detail (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cancel_claim_coverage_payment_detail.htm)** Cancel payment for a claim coverage payment detail record. - **[Check Financial Authority (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_check_financial_authority.htm)** Check whether the current user has sufficient financial authority to approve a claim coverage payment detail. The API matches a User Financial Authority (UFA) record to the payment detail’s product and financial type, compares the adjusted amount to the user’s maximum approval amount, and sets the payment detail status to Pending Authority when the limit is exceeded and a manager is available. - **[Claim (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_claim.htm)** Create a claim. - **[Claim (GET, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_claim.htm)** Get or update a claim record and its associated claim items and participants. - **[Claim Coverage (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_claim_coverage.htm)** Create a claim coverage record for the specified claim. - **[Claim Coverage (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_update_claim_coverage.htm)** Update a specific claim coverage record. - **[Claim Coverage Payment Detail (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_create_claim_coverage_payment_detail.htm)** Create a claim coverage payment detail record. This also generates the related records for the Insurance Policy Limit Tracking and Claim Coverage Payment Adjustment records if applicable. - **[Claim Coverage Payment Detail Edit (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_edit_claim_coverage_payment_detail.htm)** Update an existing Claim Coverage Payment Detail (CCPD) record for both loss and expense types. - **[Delete Claim Coverage Payment Detail (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_delete_claim_coverage_payment_detail.htm)** Remove unpaid claim coverage payment details by updating the status to Deleted. The API reverses the insurance policy limit tracking data to roll back consumption for the type Loss. - **[Field Set Fields (GET)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_field_set_fields.htm)** Get the fields of a field set by the field set ID and object name. - **[Policy Limits (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_generate_policy_limits.htm)** Create insurance policy limit records for the specified policy based on its defined product attributes and coverages. - **[Insurance Policy Limit Current Standings (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_calculate_policy_limit_standings.htm)** Get the calculated current standings (consumption status) for all applicable insurance policy limits. This API retrieves standings based on the policy, claim, claim coverage as well as policy coverage, insurance policy participant, and insurance policy asset. - **[Pay Claim Coverage Payment Detail (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_pay_claim_coverage_payment_detail.htm)** Process the payment for a claim coverage payment detail record. - **[Pay Ex Gratia Claim Coverage Payment Detail (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_pay_ex_gratia_claim_coverage_payment_detail.htm)** Process a discretionary ex gratia payment for a claim coverage payment detail, enabling payment even when coverage or policy limits are exceeded. - **[Process Policy Limits (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_process_policy_limits.htm)** Process the policy limits for a loss item in a claim by using the current standings of the insurance policy limits. - **[Verify Policy Coverage (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_verify_policy_coverage.htm)** Verify the applicability of a policy coverage for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. # Resources Learn about the available Insurance Design Advisor API resources. - **[Validate API Request (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_api_request_validation.htm)** Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model. - **[Validate Attribute Definitions (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_attribute_validation.htm)** Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated. - **[Validate CML Model (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_cml_model_validation.htm)** Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent. - **[Lookup Error Code (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_error_code_lookup.htm)** Look up an insurance error code to retrieve its human-readable description, root cause, and step-by-step resolution instructions. Use this resource when a product model validation error is encountered during setup and you need contextual troubleshooting guidance. - **[Get Rating Input (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_get_rating_input.htm)** Generate a sample rating input for the specified insurance product, and use the generated rating input as the request body in the Insurance Product Rating API (/connect/insurance/product-rating) after replacing sample values with real data. - **[Validate Pricing Setup (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_pricing_setup_validation.htm)** Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. - **[Validate Product Discovery (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_product_discovery_validation.htm)** Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. - **[Validate Product Model (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_product_model_validation.htm)** Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. - **[Validate User Permissions (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_design_advisor_user_permissions_validation.htm)** Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy. If the user isn’t authorized to perform the specified action, the API returns the validation status along with troubleshooting guidance. # Resources Learn more about the available insurance group benefits API resources. - **[Census Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_census_management.htm)** Create, update, clone, and map group census members and their plans. - **[Quote Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_management.htm)** Create quotes from existing contracts and apply member-level plan overrides. - **[Financial Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_financial_management.htm)** Rate quotes and members, compare census prices, and generate contract transactions. - **[Contract Lifecycle Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_contract_lifecycle_management.htm)** Issue, endorse, and renew group benefits contracts. - **[Policy Lifecycle Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_policy_lifecycle_management.htm)** Enroll members, apply mid-term adjustments, and renew member policies. #### See Also - [_Salesforce Help_: Explore Group Benefits in Digital Insurance](https://help.salesforce.com/s/articleView?id=ind.insurance_group_benefits_core_explore_group_benefits_in_digital_insurance.htm&language=en_US "Salesforce Help: Explore Group Benefits in Digital Insurance - HTML (New Window)") # Resources Learn more about the available Insurance Policy API resources. - **[Cancel Insurance Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_cancel_policy.htm)** Cancel an insurance policy version. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation. - **[Endorse Insurance Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_endorse_policy.htm)** Endorse the latest version of the insurance policy based on the context ID and effective date. You can also include other optional fields and additional details in the request body. - **[Insurance Policy Details (GET)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_get_policy.htm)** Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information. - **[Issue Insurance Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_issue_policy.htm)** Use the context ID provided in the request body to generate a new insurance policy. - **[Out-of-Sequence Endorse Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_out_of_sequence_endorsement.htm)** Create an out-of-sequence endorsement for an insurance policy. - **[Reinstate Insurance Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_reinstate.htm)** Reinstate a previously canceled insurance policy. - **[Renew Insurance Policy (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_renew_policy.htm)** Use the context ID of an existing policy to renew the policy. Modify the renewal date and also add optional fields and additional information in the request body. - **[Multi-Root Policy Issuance (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_multi_root_issue_policy.htm)** Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy. - **[Multi-Root Policy Endorsement (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_multi_root_endorsement_policy.htm)** Asynchronously endorse a multi-root insurance policy along with its child policies. - **[Multi-Root Policy Renewal (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_policy_multi_root_renew.htm)** Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies. # Resources Learn more about the available Insurance Product Administration API resources. - **[Insurance Underwriting Rules (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_create_underwriting_rules.htm)** Create an underwriting rule for a root product based on the selected state definition, transition, and object name. - **[Insurance Underwriting Rule Group Status (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_underwriting_rule_group_status.htm)** Update the status of an underwriting rule group. - **[Insurance Underwriting Rules (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_update_underwriting_rules.htm)** Update an existing underwriting rule for a root product. # Resources Learn more about the available Insurance Quoting API resources. - **[Insurance Invoke Underwriting Rule (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_underwriting_rules_invoke.htm)** Invoke underwriting rules for different object records during run time. - **[Insurance Product Rating (POST, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_rating.htm)** Rate products or update product ratings in insurance quoting processes. - **[Insurance Product Rating Details (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_rating_get_rating_details.htm)** Generate rating input details from a list of Product IDs, and use the generated rating input as the request body for the Insurance Product Rating API to evaluate product pricing. - **[Insurance Product Surcharge (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_surcharge.htm)** Update or fetch a product surcharge for a root product. - **[Insurance Product Surcharge Bulk (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_product_surcharge_bulk.htm)** Create one or more product surcharges to associate with a root product. - **[Insurance Quote (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_quote.htm)** Generate a quote or quote-ready context in multiple ways. The API accepts user inputs, generates context, runs rules and pricing, prorates, and then returns a quote ID. The API can also use a context ID to run pricing and rules, update the context, and then return a quote ID. Alternatively, the API can accept user inputs, generate context, run rules and pricing, prorate, and then return only the context ID. - **[Insurance Quote Details (GET, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_quote_details.htm)** Get or update quote details by the specified quote ID. - **[Insurance Eligible Product Clauses Add (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_add_eligible_product_clauses.htm)** Add selected eligible product clauses to a quote or context. - **[Insurance Eligible Product Clauses Get (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_eligible_product_clauses.htm)** Get eligible product clauses based on quoteId and contextId. - **[Insurance Product Clause (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clause_update.htm)** Update an existing product clause for a root product. - **[Insurance Product Clause Bulk (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clauses_bulk_create.htm)** Create one or multiple product clauses at once. - **[Insurance Product Clause Generation (POST)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_resources_insurance_product_clauses_generate.htm)** Generate product clauses based on quote and context information. # Responses Learn about the response bodies of Insurance Brokerage APIs. - **[Amount with Frequency](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_amount_with_frequency_output.htm)** Output representation of the amount details with frequency. - **[Attribute Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_attribute_detail.htm)** Output representation of product attribute details. - **[Attribute Picklist Value](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_attribute_picklist_value.htm)** Output representation of the picklist value details. - **[Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_benefits_output.htm)** Output representation details of the plan benefits for an insurance policy coverage plan. - **[Cost Calculation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cost_calculation_output.htm)** Output representation details of the cost calculation. - **[Expected Revenue Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_exp_rev_coverage_output.htm)** Output representation details of the coverage and associated expected revenue. - **[Expected Revenue Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_exp_rev_policy_output.htm)** Output representation of the associated expected revenue details for a policy, such as coverages and rate plans. - **[Expected Revenue](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_expected_revenue_output.htm)** Output representation of the details of the expected revenue. - **[Commission Processing Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_commission_processing_output.htm)** Output representation details of the commission processing. - **[Insurance Billing Schedules Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_billing_output.htm)** Details of the billing schedule creation results. - **[Insurance Policy Bulk Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_bulk_output.htm)** Output representation for bulk policy lifecycle operations. - **[Insurance Policy Process](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_process_output.htm)** Output representation details of the renewed policy. - **[Plan Benefits Product Model Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_plan_benefits_product_model_output.htm)** Output representation of the product model details and associated product components. - **[Premium Preview Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_premium_preview.htm)** Output representation of the details of the draft-state premium preview results for an insurance policy, including per-node rolled-up amounts and any errors. - **[Premium Preview Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_premium_preview_result.htm)** Output representation of the rolled-up premium amounts or per-node errors for one policy-hierarchy node. - **[Premium Preview Amounts](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_premium_preview_amounts.htm)** Contains the ten rolled-up Standard and Term premium amount fields returned for a single policy-hierarchy node during a draft-state premium preview. - **[Rate Plan Commission](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rate_plan_commission_output.htm)** Output representation details of the rate plan commission. - **[Rate Plan](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rate_plan_output.htm)** Output representation of the details of the rate plans associated directly with the policy or through coverages. - **[Product](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product.htm)** Output representation of product details. - **[Plan Benefits Attribute](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_plan_benefit_create_attributes.htm)** Represents details of the plan benefits attributes for an Insurance Policy Coverage. - **[Plan Benefits Attributes](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_benefits_attributes_output.htm)** Output representation details of the benefits attributes for an insurance policy coverage plan. - **[Plan Benefit Networks](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_network_input.htm)** Output representation details of the insurance policy coverage networks. - **[Plan Benefits](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_plan_benefit_output.htm)** Output representation details of the create and update plan benefits request. - **[Plan Benefits Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_plan_benefits.htm)** Output representation details of the insurance policy benefits. - **[Insurance Policy Issue Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_issue_output.htm)** Output representation details of the issue policy and issue endorse policy requests. - **[Insurance Policy Cancellation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_cancellation_output.htm)** Output representation details of the cancel policy request. - **[Insurance Policy Draft Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_draft_output.htm)** Output representation details of the endorsement draft policy request. - **[Insurance Policy Reinstatement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_policy_reinstatement_output.htm)** Output representation details of the reinstate policy request. # Responses Learn more about the available response bodies of insurance claim APIs. - **[Bulk Pay Claim Coverage Payment Details Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_bulk_pay_claim_coverage_payment_detail.htm)** Output representation of the details of the bulk pay CCPD API call. The API returns a system-generated request ID for tracking asynchronous processing, and any errors reported for the operation. - **[Calculate Adjustments](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_calculate_adjustments.htm)** Output representation of the details for calculating the adjustments for the claim loss item. - **[Cancel Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cancel_claim_coverage_payment_detail.htm)** Output representation for the canceled claim coverage payment detail. - **[Check Financial Authority](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_check_financial_authority.htm)** Output representation of evaluating whether the current user has sufficient financial authority to approve a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount. - **[Claim Attribute](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_attribute_output.htm)** Output representation for a claim attribute. - **[Claim Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_coverage.htm)** Output representation for a claim coverage. - **[Claim Coverage Payment Adjustment Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_cov_payment_adj_details.htm)** Output representation for the claim coverage payment adjustment details. - **[Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_coverage_payment_detail.htm)** Output representation for creating the claim coverage payment detail record. - **[Claim Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_output.htm)** Output representation for the details of a claim record. - **[Claim Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_claim_output.htm)** Output representation for a created or updated claim. - **[Claim Item](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_item_output.htm)** Output representation for the details of a claim item. - **[Claim Participant](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_participant_output.htm)** Output representation for the details of a claim participant. - **[Claim Related Object](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_claim_related_object_output.htm)** Output representation for a related object on a claim. - **[Delete Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_delete_claim_coverage_payment_detail.htm)** Output representation for the deleted claim coverage payment detail. - **[Edit Claim Coverage Payment Detail Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_edit_claim_coverage_payment_detail.htm)** Output representation for the edited claim coverage payment detail. - **[Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm)** Output representation of the error details. - **[Field Set Fields](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_field_set_fields.htm)** Output representation of the collection of fields that are associated with a specific field set. - **[Field Set Field Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_field_set_field.htm)** Output representation of the field that's associated with a specific field set. - **[Generate Policy Limits Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_create_policy_limits.htm)** Output representation for the created insurance policy limit records. - **[Insurance Policy Limit Calculation Standing Node](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_lmt_calc_standing_node.htm)** Output representation for an insurance policy limit standing calculation node. - **[Insurance Policy Limit Current Standings Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_lmt_calc_standing.htm)** Output representation for the current standings of the insurance policy limits. - **[Policy Limit Tracking Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_policy_limit_tracking_details.htm)** Output representation for the insurance policy limit tracking details. - **[Pay Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_pay_claim_coverage_payment_detail.htm)** Output representation for paying a claim coverage payment detail. - **[Pay Ex Gratia Claim Coverage Payment Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_pay_ex_gratia_claim_cvr_payment_detail.htm)** Output representation for the details of the ex gratia payment that’s made for the claim coverage payment detail. - **[Process Policy Limits Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_process_policy_limits.htm)** Output representation for processing the policy limits for a claim loss item. - **[Remaining Reserve](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_remaining_reserve.htm)** Output representation for the remaining reserve amount and scope after the payment is processed. - **[Verify Policy Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_verify_policy_coverage.htm)** Output representation of a policy coverage's applicability for a specified loss date under an insurance policy. # Responses Learn about the response bodies of Insurance Design Advisor API responses. - **[Insurance Attribute Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_attribute_validation.htm)** Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn’t. - **[Insurance Attribute Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_attribute_validation_result.htm)** Output representation of the validation result for one attribute lookup. The result echoes the identifiers from the request and includes resolution guidance when the attribute definition can’t be validated. - **[Insurance CML Model Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_cml_model_validation.htm)** Output representation of the per-record validation results and any top-level errors that occur when processing the request. - **[Insurance CML Model Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_cml_model_validation_result.htm)** Output representation of the validation result for a single record. When the record isn’t valid, the instructions paramter describes the failure and recommended correction. - **[Insurance Get Rating Input Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_get_rating_input.htm)** Output representation that contains the generated sample rating input payload as a JSON string, or errors if generation fails. - **[Insurance Lookup Error Code Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_lookup_error_code.htm)** Response representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors. - **[Insurance Pricing Setup Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_pricing_setup_validation.htm)** Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors. - **[Insurance Product Discovery Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_discovery_validation.htm)** Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages. - **[Insurance Product Model Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_model_validation.htm)** Output representation of the validation results for a product model and its hierarchy. - **[Insurance Product Hierarchy Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_hierarchy_validation.htm)** Output representation of the validation result for a single product in the root product hierarchy. The response includes products that failed at least one design-time check. - **[Insurance Request Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_request_validation.htm)** Response representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation. - **[Insurance Request Validation Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_request_validation_result.htm)** Response representation of a single request validation finding. When the finding isn’t valid, instructions describes the issue and how to resolve it. - **[Insurance Validate User Permissions Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_validate_user_permissions.htm)** Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t. - **[Insurance Design Advisor Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_details_output.htm)** Output representation of one validation diagnostic, including the error code and message. - **[Insurance Design Advisor Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_design_advisor_error_response.htm)** Output representation of a top-level error returned before per-attribute validation runs. # Responses Learn more about the available response bodies of insurance group benefits APIs. - **[Bulk Group Census Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_bulk_census_mgmt_output.htm)** Output representation for the bulk processing of employee census data. - **[Contract Endorsement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_endorse.htm)** Output representation of the details when an endorsed contract version is created from a quote. - **[Contract Renewal Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_renewal.htm)** Output representation of the details when a renewed group benefits contract is created from a quote. - **[Delete Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_delete_member_plans_output.htm)** Output representation for the member plan deletion process. - **[Family Policy Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_family_policy_info_output.htm)** Output representation for individual group policy information. - **[Group Enrollment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_enrollment_output.htm)** Output representation for the Group Enrollment API. Returns the asynchronous request ID for the bulk enrollment job, along with any errors that occurred before the job was scheduled. - **[Group Rating Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_rating_output.htm)** Output representation of the Group Benefits Group Rating process. - **[Insurance Person Accounts and Users Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_accounts_and_users_creation_output.htm)** Output representation of the person account and user creation process. - **[Insurance Member Account and User Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_member_account_and_user_details_output.htm)** Output representation of a member's person account and portal user details that are created. - **[Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm)** Output representation for an error that occurred during a census management operation. - **[Insurance Member Rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_member_rating_output.htm)** Output representation of the rating for individual members. - **[Insurance Member Rating Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_member_rating_details_output.htm)** Output representation of an individual member's rating results. - **[Insurance Plan Rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plan_rating_output.htm)** Output representation of an individual plan's pricing result. - **[Insurance Coverage Rating](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_coverage_rating_output.htm)** Output representation of an individual coverage's pricing result. - **[Insurance Contribution](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contribution_output.htm)** Output representation of contribution information in an individual rating. - **[Insurance Object Map](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_object_map_output.htm)** Output representation for a map of attributes with string keys and object values. - **[Insurance Contacts and Users Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contacts_and_users_creation_output.htm)** Output representation of the contact and user creation process. - **[Insurance Contract Transactions Generation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_generate_txn_output.htm)** Output representation of the details when you start asynchronous generation of contract transactions for a group benefits contract. - **[Insurance Member Contact and User Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_member_contact_and_user_details_output.htm)** Output representation of a member's contact and portal user details that's created. - **[Insurance Group Census Member Management](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_mgmt_output.htm)** Output representation for the details of the group census members. - **[Insurance Census Summary Sync Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_census_summary_sync_output.htm)** Output representation of an employee census summary synchronization. - **[Insurance Group Census Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_census_output.htm)** Output representation of group census summary data. - **[Group Census Deep Clone Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_group_census_deep_clone.htm)** Output representation of the details that are returned after a group census deep-clone request is processed. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[Group Census Field Mapping Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_group_census_field_mapping.htm)** Output representation of the details that are returned after a group census field-mapping request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[Members With Plans Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_members_with_plans.htm)** Details returned after a family of group census members and their plans is added or updated. The response includes a success flag, top-level errors, and per-member results. - **[Member With Plans Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_member_with_plans.htm)** Details for one group census member that was created or updated, including the member ID, associated plan IDs, and any member-level errors. - **[Member Overrides Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_member_overrides.htm)** Output representation of the details that are returned after member overrides are upserted or cloned on a root quote line item. The response includes a success parameter to indicate if the operation is successful and any errors that occurred during processing if the operation didn't succeed. - **[Insurance Group Endorsement Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_endorsement.htm)** Output representation of the details that are returned after a request to apply mid-term contract adjustments to member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[Insurance Group Adjustment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_adjustment.htm)** Output representation of the details that are returned after a bulk mid-term adjustment request is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[Insurance Group Renewal Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_renewal.htm)** Output representation of the details that are returned after a request to renew member policies is accepted. The response includes the asynchronous request ID and any errors that occurred while validating or scheduling the job. - **[Price Comparison Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_output.htm)** Output representation of the price impact that's calculated for a group census. The response includes the available product categories, the event summary, the rating periods, the currency, and a flat list of comparison items that carry the previous and current amounts for each plan, group class, member, and coverage. - **[Price Comparison Item Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item.htm)** Output representation of the details of a single node in the price comparison, such as the overall summary, a plan, a group class, a member, or a coverage. The comparison is returned as a flat list of items. Build the hierarchy by matching the parent value of an item with the id value of another item. - **[Price Comparison Impact Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_impact.htm)** Output representation of the priced amounts for one side of a comparison. Each comparison item returns this representation twice, once as the previous amounts and once as the current amounts, so that you can show the price impact of the change. - **[Price Comparison Attribute Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_attribute.htm)** Output representation of the details of a single plan or coverage attribute, such as copay or coinsurance, that's returned with a price comparison node. Attributes are returned only when the request sets fetchAttributes to true. - **[Price Comparison Currency Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_currency.htm)** Output representation of the details of the currency that all amounts in a price comparison are expressed in. Use these details to format the previous and current amounts for display. - **[Price Comparison Duration Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_item_duration.htm)** Output representation of the details of a rating period that the comparison amounts apply to. Match the key value with the durationKey value of a comparison item to find the period that the item's amounts cover. - **[Price Comparison Summary Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_price_comparison_summary.htm)** Output representation of the counts of the membership events in the group census that contribute to the price change, such as hires, endorsements, and terminations. Use these counts to explain why the price moved between the previous and the current amounts. - **[Group Census Group Class Summary](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_grp_census_grp_class_summary_output.htm)** Output representation of census summary data aggregated by group class. - **[Insurance Update Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_member_plans_output.htm)** Output representation for the update member plans operation. - **[Insurance Add Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_add_member_plans_output.htm)** Output representation for the add member plans operation. - **[Insurance Member Eligible Plans Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_members_plans.htm)** Output representation for a member's eligible plans. - **[Members Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_members_plans_details_list.htm)** Output representation for a list of members with their eligible plans. - **[Insurance Member Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_member_plans_output.htm)** Output representation of the Insurance Get Member Plans service for an individual member. - **[Insurance Plan List](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plan_list_output.htm)** Output representation for a list of contract group plans. - **[Insurance Plan Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plan_output.htm)** Output representation for contract group plans. - **[Insurance Plans Eligibility Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_plans_eligibility_output.htm)** Output representation of the insurance plan eligibility check. - **[Eligible Plan Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_eligible_plan_details_output.htm)** Output representation for the details of the eligible plans. - **[Insurance Message Output](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_message_output.htm)** Output representation of an insurance message, which can be informational or an error. - **[Insurance Group Plans](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_plan_output.htm)** Output representation of an insurance group plan. - **[Contract Creation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_contract_creation_output.htm)** Output representation of the group benefits Quote-to-Contract process. - **[Insurance Create Quote From Contract Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_quote_from_contract_output.htm)** Response returned when creating a group benefits quote from an existing contract. - **[Insurance Generate Census Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_generate_census.htm)** Output representation of the details when you generate a group census from the policies on an existing group benefits contract. - **[Update Group Census Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_refresh_census.htm)** Output representation of the details that are returned when you update a group census from policy enrollments and endorsements on an existing group benefits contract. - **[Insurance Generate Refresh Census Members Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_generate_refresh_census_members.htm)** Output representation of the details when you generate or update group census members from policy information on an existing group benefits contract. - **[Issue Contract Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_issue_contract.htm)** Output representation of the details when a group benefits contract is issued synchronously from a quote. - **[Individual Enrollment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_individual_enrollment_output.htm)** Output representation for the Individual Enrollment API. - **[Individual Mid-Term Adjustment Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_individual_mta_output.htm)** Output representation for the Individual Mid-Term Adjustment API. - **[Insurance Group Plan UI Treatment](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_group_plan_ui_treatment_output.htm)** Output representation of a UI treatment returned by the configurator for a plan or coverage. # Responses Learn more about the available response bodies of Insurance Policy APIs. - **[Cancel Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_cancel_policy_output.htm)** Output representation of cancel policy details. - **[Get Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_policy_output.htm)** Output representation of policy details. - **[Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_output.htm)** Output representation of policy details. - **[Refund](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_refund_output.htm)** Output representation of refund details. - **[Out-of-Sequence Endorse Policy](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_out_of_sequence_endorse_policy.htm)** Output representation of the details for the out of sequence policy endorsement process. - **[Error Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details_output.htm)** Output representation for the details of the error code and error message. - **[Error Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_output.htm)** Output representation of the error details. - **[Multi-Root Policy Asynchronous Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_policy_async.htm)** Details of the multi-root policy that's processed asynchronously. # Responses Learn more about the available response bodies of Insurance Product Administration APIs. - **[Insurance Create Underwriting Rules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_underwriting_rules_output.htm)** Output representation details of insurance create underwriting rules request. - **[Insurance Underwriting Rule Group Update Status](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rule_group_update_status_output.htm)** Output representation of insurance underwriting rule group update status request. - **[Insurance Underwriting Rules Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rules_error.htm)** Details of the error response. - **[Insurance Update Underwriting Rules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_underwriting_rules_output.htm)** Output representation details of the insurance update underwriting rules request. # Responses Learn more about the available response bodies of Insurance Quoting APIs. - **[Add Eligible Product Clauses Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_add_eligible_product_clauses_output.htm)** Output representation for adding eligible product clauses. - **[Context JSON](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_context_j_s_o_n_output.htm)** Output representation for the context JSON. - **[Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_detail_output.htm)** Output representation of the error details. - **[Get Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_quote_output.htm)** Output representation of the details of the get quote details. - **[Insurance App Usage Assignment](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_app_usage_assignment_output.htm)** Output representation for the insurance app usage assignment. - **[Insurance Configurator Message](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_config_message_output.htm)** Output representation of configurator messages. - **[Insurance Get Eligible Product Clauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_get_eligible_clauses_output.htm)** Output representation for eligible clauses. - **[Insurance Invoke Underwriting Rule](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_invoke_underwriting_rule_output.htm)** Output representation for invoke underwriting rule response. - **[Insurance Invoke Underwriting Rule Set Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_invoke_underwriting_ruleset_result_output.htm)** Output representation for invoke underwriting rule set result response. - **[Insurance Line Item Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_line_item_detail_output.htm)** Output representation of the enriched line item details for an underwriting rule result. - **[Insurance Product Clause Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_product_clause.htm)** Output representation for insurance product clause. - **[Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_quote_output.htm)** Output representation of the details of the insurance quote. - **[Insurance Sales Transaction](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_output.htm)** Output representation for the insurance sales transaction. - **[Insurance Sales Transaction Item](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_output.htm)** Output representation for the insurance sales transaction item. - **[Insurance Sales Transaction Item Attribute](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_a_output.htm)** Output representation for the details of the insurance sales transaction item attribute. - **[Insurance Sales Transaction Item Clause](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_clause_output.htm)** Output representation for the details of the insurance sales transaction item clause. - **[Insurance Sales Transaction Item Relationship](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_relationship_output.htm)** Output representation for the details of the Insurance Sales Transaction Item Relationship. - **[Insurance Sales Transaction Item Related Object](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_r_o_output.htm)** Output representation for the details of the Insurance Sales Transaction Item Related Object. - **[Insurance Sales Transaction Item Tax](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_s_t_i_tax_output.htm)** Output representation for the details of the Insurance Sales Transaction Item Tax. - **[Insurance Underwriting Rule Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_underwriting_rule_result_output.htm)** Underwriting rule evaluation result. - **[Insurance UI Treatments](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_u_i_treatment_output.htm)** Output representation for the details of the insurance UI treatments. - **[Product Clause Generation Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_clause_generation_output.htm)** Output representation of the details for a clause generation request. - **[Product Clause Creation Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_product_clause_list_output.htm)** Output representation for the bulk creation of product clauses. - **[Product Clauses](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_create_product_clause_output.htm)** Output representation for a successfully created product clause. - **[Product Clause Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_product_clause_error.htm)** Output representation of an error that occurred during the product clause operation. - **[Product Clause Update Details](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_update_product_clause_output.htm)** Output representation of the details for an updated product clause. - **[Product Rating Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_rating_output.htm)** Output representation for the Product Rating Connect API. - **[Product Surcharge List](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_surcharge_list_output.htm)** Output Representation for List of ProductSurcharge - **[Product Surcharge Patch](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_product_surcharge_patch_output.htm)** Output representation of product surcharge update. - **[Product Rating Details Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_get_rating_details_output.htm)** Output representation that contains the constructed rating request payload. - **[Rating Input Node Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_input_node_output.htm)** Output representation of a single node in the rating input hierarchy. - **[Rating Options](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_options_output.htm)** Output representation of the rating options that are returned in the response. - **[Rating Result](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_rating_result_output.htm)** Output representation for the details of the product rating pricing results. # Revert Member Overrides Action Revert all overrides for a member under a root quote line item and restore the member details to the default configuration of the group class. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/revertMemberOverrides Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | memberId | string | Required. ID of the GroupCensusMember whose bespoke overrides are reverted. | | rootQliId | string | Required. ID of the root plan QuoteLineItem whose member overrides are reverted. | ## Outputs | Output | Type | Description | | --- | --- | --- | | resultMessage | string | Message describing the result of the revert operation. | ## Example **POST** This sample request is for the Revert Member Overrides action. { "inputs": \[ { "memberId": "0r6xx000000001aEAA", "rootQliId": "0QLxx0000004CtoCAE" } \] } This sample response is for the Revert Member Overrides action. \[ { "actionName": "revertMemberOverrides", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "resultMessage": "The operation succeeded successfully." }, "sortOrder": -1, "version": 1 } \] # runtime\_industries\_insurance Namespace The runtime\_industries\_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation. The runtime\_industries\_insurance namespace includes these classes. ## Usage You can access the runtime\_industries\_insurance classes if your org has the Insurance feature. These Options classes are used with group insurance quoting, product configuration, and policy administration workflows. - **[AddEligibleInsuranceClausesOptions Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions.htm#apex_class_runtime_industries_insurance_AddEligibleInsuranceClausesOptions)** Contains options for adding eligible product clauses to an insurance product. Use this class when configuring which clauses, such as exclusions or coverage terms, are available for selection on an insurance product. - **[CreateInsuranceQuoteOptions Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions.htm#apex_class_runtime_industries_insurance_CreateInsuranceQuoteOptions)** Contains options for creating an insurance quote. Use this class to control pricing execution, product catalog validation, configuration and qualification rules, quote persistence, and the product selling model when creating group or individual insurance quotes. - **[CreateInsuranceRatingOptions Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions.htm#apex_class_runtime_industries_insurance_CreateInsuranceRatingOptions)** Contains options for creating an insurance rating. Use this class to control pricing execution, configuration rules, and the response data, such as context JSON, product details, rating results, when running a rating operation. - **[GenerateInsuranceClausesOptions Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions.htm#apex_class_runtime_industries_insurance_GenerateInsuranceClausesOptions)** Contains options for generating insurance clauses. Use this class to control context saving, manual clause generation, and asynchronous clause generation when generating product clauses for insurance products. - **[UpdateInsuranceQuoteOptions Class](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions)** Contains options for updating an existing insurance quote. Use this class to control pricing execution, configuration and qualification rules, product catalog validation, and quote persistence when updating insurance quotes. # Save Group Census Member Plans Data Action Validate and save group census member plans for the new members. Update the group census member plans for existing members. This action processes member enrollment information, validates plan assignments, and handles primary and dependent member relationships. It manages plan updates, including plan additions and deletions, and supports bulk processing of member plans with comprehensive error handling and logging. This action is available in API version 66.0 and later. ## Special Access Rules To use this invocable action, you must have Digital Insurance Group Benefits Census Management user access ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/saveGrpCensusMbrPlansData Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | asyncBulkRequestItemId | string | Required. ID of the asynchronous bulk request item to use for tracking and error logging. | | groupCensusId | string | Required. ID of the group census record. | | groupCensusMemberPlans | sobject | Required. List of group census member plan records to save. | | groupCensusMembers | sobject | Required. List of group census member records to process. | | shouldLogErrors | boolean | Required. Indicates whether errors that occur while saving group census member plans are recorded in a content document ( true ) or not ( false ). | ## Outputs | Output | Type | Description | | --- | --- | --- | | errorsData | Apex-defined | Error details for the failed records. | | groupCensusMemberPlans | sobject | Details of group census member plan records that are successfully saved. | ## Example **POST** This sample request is for the Save Group Census Member Plans Data action. { "inputs": \[ { "groupCensusMembers": \[ { "Id": "a1B000000000001", "MemberRefId": "M001", "PrimaryGroupCensusMemberId": null, "GroupCensusId": "a3B000000000001", "MemberKey": "EMP001", "AssociationWithPrimaryMbr": "Self" }, { "Id": "a1B000000000002", "MemberRefId": "M002", "PrimaryGroupCensusMemberId": "a1B000000000001", "GroupCensusId": "a3B000000000001", "MemberKey": "DEP001", "AssociationWithPrimaryMbr": "Spouse" } \], "groupCensusMembersPlans": \[ { "ContractGroupPlanId": "p1B000000000001", "PlanName": "Health Plan A", "PlanType": "Medical", "GroupCensusMember": "a1B000000000001", "MemberRefId": "M001" }, { "ContractGroupPlanId": "p1B000000000002", "PlanName": "Dental Plan B", "PlanType": "Dental", "GroupCensusMember": "a1B000000000001", "MemberRefId": "M001" }, { "ContractGroupPlanId": "p1B000000000001", "PlanName": "Health Plan A", "PlanType": "Medical", "GroupCensusMember": "a1B000000000002", "MemberRefId": "M002" } \], "shouldLogErrors": true, "asyncBulkRequestItemId": "a2B000000000001", "groupCensusId": "a3B000000000001" } \] } This sample response is for the Save Group Census Member Plans Data action. { "outputs": \[ { "savedGroupCensusMembersPlans": \[ { "Id": "a4B000000000001", "Name": "Plan-001", "GroupCensusMemberId": "a1B000000000001", "ContractGroupPlanId": "p1B000000000001", "CreatedDate": "2025-01-27T10:30:00.000Z", "CreatedById": "005000000000001" }, { "Id": "a4B000000000002", "Name": "Plan-002", "GroupCensusMemberId": "a1B000000000001", "ContractGroupPlanId": "p1B000000000002", "CreatedDate": "2025-01-27T10:30:00.000Z", "CreatedById": "005000000000001" }, { "Id": "a4B000000000003", "Name": "Plan-003", "GroupCensusMemberId": "a1B000000000002", "ContractGroupPlanId": "p1B000000000001", "CreatedDate": "2025-01-27T10:30:00.000Z", "CreatedById": "005000000000001" } \], "errors": \[ { "errorMessage": "Invalid plan assignment for member M003", "recordId": "M003", "errorType": "VALIDATION\_ERROR", "fieldName": "ContractGroupPlanId" } \], "isSuccess": true } \] } # Save Group Census Members Data Action Create or update the group census member records for primary members, update the IDs of the dependent members, and create or update groups census member records for the dependent members. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/saveGroupCensusMembersData Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | asyncBulkRequestItemId | string | ID of the async bulk request item to use as reference for creating insurance async bulk record details records. | | groupCensusId | string | ID of the parent group census record that's associated with the group census member records. | | groupCensusMembers | sobject | Collection of group census member records to be save. Maximum limit size is 2000. | | operation | string | Required if asyncBulkRequestItemId isn't specified. Operation to perform on the group census member records. Valid values are Add and Update. | | shouldLogErrors | boolean | Indicates whether errors that occur while saving group census member plans must be recorded in a content document ( true ) or not ( false ). The default values is false . | ## Outputs | Output | Type | Description | | --- | --- | --- | | errorsData | Apex-defined | Collection of error records for synchronous Add Members and Update Members services. Maximum limit is 2000. | | savedGroupCensusMembers | sobject | Collection of group census member records that are created or updated during the execution of the action. It contains both primary and dependent members that are successfully processed. Maximum limit is 2000. | ## Example Sample Request { "inputs": \[ { "asyncBulkRequestItemId": "15Uxx0000004CfoEAE", "groupCensusId": "0rfxx0000000005AAA", "groupCensusMembers": \[ { "Name": "IronMan", "FirstName": "Iron", "Lastname": "Man", "Gender": "Male", "GroupClassId": "0rExx0000000001EAA", "GroupClassName": "Executive", "GroupCensusId": "0rfxx0000000005AAA", "Email": "test1@gtest.com", "AssociationWithPrimaryMbr": "Self", "MemberKey": "c01c21aecc57e259f2faeb9484149c8e" } \] } \] } Sample Response { "actionName": "saveGroupCensusMembersData", "savedGroupCensusMembers": \[ { "attributes": { "type": "GroupCensusMember" }, "Email": "test2@gtest.com", "AssociationWithPrimaryMbr": "Spouse", "FirstName": "Pepper", "MemberKey": "ad8b415683d7e6b6cc8d5a975c8cf75b", "Lastname": "Potts", "Gender": "Female", "GroupCensusId": "0rfxx0000000005AAA", "Name": "PepperPotts" } \] } # Update Census Information from Policies for Contract (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. 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. ## Resource {contractId} is a placeholder. /connect/insurance/contracts/{contractId}/actions/upsert-members ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/upsert-members ## Available Version 68.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the insurance contract whose policy data is used to generate or update group census member information. | Required | 68.0 | ## Request Body for POST ### JSON Example { "censusName": "Acme Enrollment Census 2026", "censusType": "Enrollment", "groupCensusId": "0rfxx0000004C92AAA", "policyEffectiveDate": "2026-01-01", "shouldGenerateCsv": true, "shouldIncludeMemberPlans": true, "personAccountIds": \[ "001xx000003DGb2AAG" \], "contactIds": \[ "003xx000004WhKhAAK" \], "policyIds": \[ "0YTxx0000004C92GAE" \], "additionalFields": { "members": \[ { "memberId": "0YLxx0000004C92EAG", "fields": \[ { "key": "Status\_\_c", "value": "Active" } \] } \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalFields | [Insurance Generate Refresh Census Members Additional Fields Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_generate_refresh_census_members_additional_fields.htm "Input representation of the additional field values to apply to group census members during a generate or refresh census members operation.") | Additional field values to apply to each group census member during the upsert operation. Use this parameter to set nonstandard fields, such as extended or custom fields. | Optional | 68.0 | | censusName | String | Name for the group census record. | Optional | 68.0 | | censusType | String | Type of census, for example Enrollment or Quote. | Optional | 68.0 | | contactIds | String\[\] | Contact IDs used to extract member information. If you specify contact IDs, you must also specify a policy ID to correctly identify the associated members. | Optional | 68.0 | | groupCensusId | String | ID of the group census. Required when you update existing group census member details. | Optional | 68.0 | | personAccountIds | String\[\] | IDs of the Person Accounts used to identify the members to include when processing the group census. Member information is extracted from the specified accounts. | Optional | 68.0 | | policyEffectiveDate | String | Date used to determine the policy version for generating or updating group census member details, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 | | policyIds | String\[\] | Policy IDs from which member information is retrieved for the specified contacts or accounts. | Optional | 68.0 | | shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census data (true) or not (false). | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members in the processed group census ( true) or not ( false). If set to true, the group census includes insurance plan details for each member. | Optional | 68.0 | ## Response Body for POST [Insurance Generate Refresh Census Members Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_generate_refresh_census_members.htm "Output representation of the details when you generate or update group census members from policy information on an existing group benefits contract.") # Update Claim Action Update a claim. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/updateClaim Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | updateClaimInputRepresentation | Apex-defined | Required. An Apex [ConnectApi.UpdateClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim.htm "Invocable action input representation for the update claim action.") record that contains the details of the claim to be updated. | ## Outputs | Output | Type | Description | | --- | --- | --- | | claimId | string | ID of the claim that's updated. | ## Example Sample Request { "inputs": \[ { "updateClaimInputRepresentation": { "calimId": "0Z1S70000004oVfIAI", "name": "Claim for Auto Accident", "lossDate": "2025-09-15", "claimType": "Auto", "claimReason": "Rear-end collision", "claimReasonType": "Accident", "lossType": "Accident", "insurancePolicyId": "0YTx0000000001qEAA", "accountId": "001xx000003DGQyAAO", "expenseReserveAmount": 750.50, "expenseReserveAdjustmentReason": "Initial expense reserve", "lossReserveAmount": 5000.00, "lossReserveAdjustmentReason": "Initial loss reserve", "additionalFields": { "key": "RepairShop", "value": "NY" }, "attributes": \[ { "apiName": "WeatherConditions", "value": "Clear and Sunny" }, { "apiName": "NumberOfVehicles", "value": "2" } \], "items": \[ { "instanceKey": "item\_vehicle\_damage\_01", "name": "Damaged Rear Bumper and Trunk", "productCode": "AUTO-SEDAN-2023", "category": "Auto Physical Damage", "insuredItemId": "02ixx0000004l5sAAA", "insurancePolicyCoverageId": "0cvxx000000AbCdEfG", "attributes": \[ { "apiName": "DamageSeverity", "value": "Moderate" } \], "additionalFields": { "RepairEstimate": 2750 }, "relatedObjects": \[ { "relatedRecordId": "001xx000003DGQzAAP", "relatedRecordObjName": "Account" } \], "participantInstanceKey": "participant\_driver\_01", "action": "update" } \], "participants": \[ { "instanceKey": "participant\_driver\_01", "contactId": "003xx000003DGQyAAO", "accountId": "001xx000003DGQyAAO", "insurancePolicyParticipantId": "0pPxx000000001qEAA", "isInjured": false, "roles": \[ "Driver", "Claimant" \], "additionalFields": { "key": "StatementTaken", "value": true }, "action": "update" } \] } } \] } Sample Response \[ { "actionName": "createClaim", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "claimId": "0Z1S70000004oVfIAI" }, "sortOrder": -1, "version": 1 } \] # Update Claim Coverage Action Update a claim coverage. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/updateClaimCoverage Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | updateClaimCoverageInputRep | Apex-defined | Required. An Apex [ConnectApi.UpdateClaimCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim_coverage_input_re.htm "Input representation for the update claim coverage action.") record that contains the details of the claim coverage to be updated. | ## Outputs | Output | Type | Description | | --- | --- | --- | | coverageId | string | ID of the claim coverage that's updated. | ## Example Sample Request { "inputs": \[ { "updateClaimCoverageInputRep": { "claimId": "0Z1S70000004oVfIAI", "coverageId": "1ccS70000004oVfIAI", "expenseReserveAmount": 500, "lossReserveAmount": 2000, "additionalFields": { "Status": "Approved" } } } \] } Sample Response \[ { "actionName": "updateClaimCoverage", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "coverageId": "1ccS70000004oVfIAI" }, "sortOrder": -1, "version": 1 } \] # Update Group Census (PATCH) 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. ## Resource {contractId} is a placeholder. /connect/insurance/contracts/{contractId}/actions/refresh-census ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/refresh-census ## Available Version 68.0 ## HTTP Methods PATCH ## Path Parameter for PATCH | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contractId | String | ID of the insurance contract whose policy enrollments and endorsements are used to update the group census. | Required | 68.0 | ## Request Body for PATCH ### JSON Example { "groupCensusId": "0rfxx0000004C92AAA", "startDate": "2026-01-01", "endDate": "2026-03-31", "policyEffectiveDate": "2026-01-01", "shouldGenerateCSV": true, "shouldIncludeMemberPlans": true, "groupCensusAdditionalFields": \[ { "key": "Status\_\_c", "value": "Active" } \], "filter": { "contractGroupPlanIds": \[ "0gpxx0000000001AAA" \], "objectName": "Contact", "recordIds": \[ "003xx000004WhKhAAK" \] } } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | endDate | String | End date of the time period that's used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format. | Required | 68.0 | | filter | [Insurance Census Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_filter_input.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that identify which policy records associated with the insurance contract to include when updating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 | | groupCensusAdditionalFields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value. | Optional | 68.0 | | groupCensusId | String | ID of the group census record to update. | Required | 68.0 | | policyEffectiveDate | String | Date that's used to determine the policy version for updating member and plan configuration details, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Required | 68.0 | | requestId | String | ID of the asynchronous request from a previous run. Use with groupCensusId to retry updating the records that failed in a previous run. | Required to rerun the asynchronous job to update a group census that failed in a previous run | 68.0 | | shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with the updated group census details ( true) or not ( false). The default value is false. | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members when updating the group census ( true) or not ( false). The default value is false. | Optional | 68.0 | | startDate | String | Start date of the time period that's used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format. | Required | 68.0 | ## Response Body for PATCH [Update Group Census Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_refresh_census.htm "Output representation of the details that are returned when you update a group census from policy enrollments and endorsements on an existing group benefits contract.") # Update Group Census Action Asynchronously update a group census using the insurance contract data. Specify the date range, and the API updates the group census member and plan configuration details based on the policy enrollments or adjustments during the specified time period. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/refreshCensus Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | contractId | string | Required. ID of the insurance contract whose details to use to update the group census. | | insRefreshCensusInputRep | Apex-defined | Required. An Apex ConnectApi.InsuranceRefreshCensusInputRepresentation record that contains the configuration details for updating a group census. | ## Outputs | Output | Type | Description | | --- | --- | --- | | insRefreshCensusRep | Apex-defined | An Apex ConnectApi.InsuranceRefreshCensusRepresentation record that contains the asynchronous request ID and the ID of the group census record that’s updated. | ## Example **POST** This sample request is for the Update Group Census action. { "inputs": \[ { "contractId": "800xx0000004C92AAE", "insRefreshCensusInputRep": { "groupCensusId": "0rfxx0000004C92AAA", "startDate": "2026-01-01", "endDate": "2026-03-31", "policyEffectiveDate": "2026-01-01", "shouldGenerateCSV": true, "shouldIncludeMemberPlans": true, "groupCensusAdditionalFields": \[ { "key": "Status\_\_c", "value": "Active" } \], "filter": { "contractGroupPlanIds": \[ "0gpxx0000000001AAA" \], "objectName": "Contact", "recordIds": \[ "003xx000004WhKhAAK" \] } } } \] } This sample response is for the Update Group Census action. \[ { "actionName": "refreshCensus", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "insRefreshCensusRep": { "message": "Census generation started successfully", "groupCensusId": "0rfxx0000004C92AAA", "requestId": "08Pxx0000000001EAA" } }, "sortOrder": -1, "version": 1 } \] # Update Group Census Input Input representation of the details to update a group census from policy enrollments and endorsements on an existing group benefits contract. ## JSON Example { "groupCensusId": "0rfxx0000004C92AAA", "startDate": "2026-01-01", "endDate": "2026-03-31", "policyEffectiveDate": "2026-01-01", "shouldGenerateCSV": true, "shouldIncludeMemberPlans": true, "groupCensusAdditionalFields": \[ { "key": "Status\_\_c", "value": "Active" } \], "filter": { "contractGroupPlanIds": \[ "0gpxx0000000001AAA" \], "objectName": "Contact", "recordIds": \[ "003xx000004WhKhAAK" \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | endDate | String | End date of the time period that's used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format. | Required | 68.0 | | filter | [Insurance Census Filter Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_census_filter_input.htm "Input representation of the filter criteria that select which policy records to include when generating a group census from a contract.") | Filter criteria that identify which policy records associated with the insurance contract to include when updating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts. | Optional | 68.0 | | groupCensusAdditionalFields | [Apex String](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_insurance_apex_string.htm "Input representation for a key-value pair.")\[\] | Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value. | Optional | 68.0 | | groupCensusId | String | ID of the group census record to update. | Required | 68.0 | | policyEffectiveDate | String | Date that's used to determine the policy version for updating member and plan configuration details, in YYYY-MM-DD format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Required | 68.0 | | requestId | String | ID of the asynchronous request from a previous run. Use with groupCensusId to retry updating the records that failed in a previous run. | Required to rerun the asynchronous job to update a group census that failed in a previous run | 68.0 | | shouldGenerateCSV | Boolean | Indicates whether to create a CSV file with the updated group census details (true) or not (false). The default value is false. | Optional | 68.0 | | shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members when updating the group census (true) or not (false). The default value is false. | Optional | 68.0 | | startDate | String | Start date of the time period that's used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format. | Required | 68.0 | # Update Group Census Response Output representation of the details that are returned when you update a group census from policy enrollments and endorsements on an existing group benefits contract. ## JSON Example { "isSuccess": true, "message": "Census refresh started successfully", "groupCensusId": "0rfxx0000004C92AAA", "requestId": "08Pxx0000000001EAA", "errors": null } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Insurance Error](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_insurance_error_output.htm "Output representation for an error that occurred during a census management operation.")\[\] | List of errors that occurred while refreshing the group census. Shows null when the request succeeds. | Small, 68.0 | 68.0 | | groupCensusId | String | ID of the group census record that's updated. | Small, 68.0 | 68.0 | | isSuccess | Boolean | Indicates whether the API operation started successfully (true) or not (false). | Small, 68.0 | 68.0 | | message | String | Message describing the result of the asynchronous census refresh process. | Small, 68.0 | 68.0 | | requestId | String | ID of the asynchronous request that updates the group census for the specified group benefits contract. Use this ID to track the job or to retry a failed run. | Small, 68.0 | 68.0 | # Update Insurance Quote Action Update an existing insurance quote by adding, updating, or deleting nodes and optionally executing pricing and rules. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/updateInsuranceQuote Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | addedNodes | string | JSON string that contains the set of nodes that must be added to the quote. | | additionalFields | string | JSON string that contains additional fields that must be updated in the quote context. | | contextId | string | ID of the context that's used to issue the quote update. | | deletedNodes | string | JSON string that contains the set of nodes that must be deleted from the quote. | | pricingProcedureApiName | string | API name of the pricing procedure that's used to price the product. | | quoteId | string | Required. ID of the insurance quote that must be updated. | | quoteOptions | Apex-defined | An Apex [runtime\_industries\_insurance.UpdateInsuranceQuoteOptions](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm "HTML (New Window)") record that contains the configuration and execution options to update the quote. | | updatedNodes | string | JSON string that contains the set of nodes that must be updated in the quote. | ## Outputs | Output | Type | Description | | --- | --- | --- | | contextId | string | ID of the context that's used to issue the quote update. | | errorsList | string | List of errors that occurred during the update operation. | | isSuccess | boolean | Indicates whether the update operation is successful ( true ) or not ( false ). | | quoteId | string | Required. ID of the insurance quote that's updated. | ## Example **POST** This sample request is for the Update Insurance Quote action. { "inputs": \[ { "quoteId": "0Q0xx000000001xAAA", "contextId": "11oxx000001G0lUAAS", "pricingProcedureApiName": "StandardPricing", "addedNodes": "\[{"productCode":"autoBundle","instanceKeys":\["multiAuto","autoBundle"\],"attributes":{"VehicleYear":"2024","VehicleMake":"Toyota"},"items":\[{"productCode":"auto","instanceKeys":\["multiAuto","autoBundle","auto"\],"attributes":{"VehicleType":"Sedan"}}\]}\]", "updatedNodes": "\[{"productCode":"driver","instanceKeys":\["multiAuto","autoBundle","driverTom"\],"attributes":{"DriverAge":"35","LicenseNumber":"D1234567"}}\]", "deletedNodes": "\[{"productCode":"coverage","instanceKeys":\["multiAuto","autoBundle","auto","collision"\]}\]", "additionalFields": "{"customField1":"value1","customField2":"value2"}", "quoteOptions": { "executePricing": true, "executeConfigurationRules": true, "executeQualificationRules": false, "validateProductCatalog": true, "saveQuote": false } } \] } This is a sample request to call this invocable action from Apex code. // Sample Apex call for updateInsuranceQuote invocable action public class UpdateInsuranceQuoteInvoke { private static final String ACTION\_NAME = 'updateInsuranceQuote'; public static Boolean invokeMethod(Map inputs, Map output) { if (output == null) { output = new Map(); } try { Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME); // Required input setInvocationParameter(action, inputs, 'quoteId', false); // Optional inputs setInvocationParameter(action, inputs, 'contextId', false); setInvocationParameter(action, inputs, 'addedNodes', true); setInvocationParameter(action, inputs, 'updatedNodes', true); setInvocationParameter(action, inputs, 'deletedNodes', true); setInvocationParameter(action, inputs, 'additionalFields', true); // quoteOptions is required by the IA contract if (inputs != null && inputs.containsKey('quoteOptions')) { Map optionsFromInput = (Map) inputs.get('quoteOptions'); if (optionsFromInput != null) { runtime\_industries\_insurance.UpdateInsuranceQuoteOptions quoteOptions = new runtime\_industries\_insurance.UpdateInsuranceQuoteOptions(); if (optionsFromInput.containsKey('executePricing')) { quoteOptions.executePricing = (Boolean) optionsFromInput.get('executePricing'); } if (optionsFromInput.containsKey('validateProductCatalog')) { quoteOptions.validateProductCatalog = (Boolean) optionsFromInput.get('validateProductCatalog'); } if (optionsFromInput.containsKey('executeConfigurationRules')) { quoteOptions.executeConfigurationRules = (Boolean) optionsFromInput.get('executeConfigurationRules'); } if (optionsFromInput.containsKey('executeQualificationRules')) { quoteOptions.executeQualificationRules = (Boolean) optionsFromInput.get('executeQualificationRules'); } if (optionsFromInput.containsKey('saveQuote')) { quoteOptions.saveQuote = (Boolean) optionsFromInput.get('saveQuote'); } action.setInvocationParameter('quoteOptions', quoteOptions); } } List results = action.invoke(); if (results != null && !results.isEmpty() && results\[0\].isSuccess()) { output.put('output', results\[0\].getOutputParameters()); output.put('success', true); return true; } output.put('success', false); if (results != null && !results.isEmpty()) { output.put('errors', results\[0\].getErrors()); } return false; } catch (Exception e) { output.put('success', false); output.put('errorMessage', e.getMessage()); return false; } } private static void setInvocationParameter( Invocable.Action action, Map payload, String attribute, Boolean serializeJson ) { if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) { if (serializeJson) { action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute))); } else { action.setInvocationParameter(attribute, payload.get(attribute)); } } } } This sample response is for the Update Insurance Quote action. \[ { "actionName": "repriceInsuranceProduct", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "isSuccess": true, "quoteId": "0Q0xx000000001xAAA", "contextId": "11oxx000001G0lUAAS", "errorsList": "\[\]" }, "sortOrder": -1, "version": 1 } \] # Update Plan Benefit Input Update Insurance Policy Coverage Networks and Insurance Policy Coverage Benefits by using the ID of an Insurance Policy Coverage. ## JSON Example { "networks": \[ { "networkId": "1HXSG0000002xxxxAM", "name": "Preferred Network Updated" }, { "networkId": "1HXSG0000002xxxxA2", "name": "In Network Updated" }, { "network": "Third Network Tier", "name": "Out Network" } \], "benefits": \[ { "benefitId": "1HSSG0000005Ws7xxE", "productId": "01tSG0000011yBFxxY", "productCompGgpId": "0y7SG0000000ZiXxxU", "productName": "Chiropractic Care", "attributes": \[ { "covBnftAttrId": "1HYSG00000002GPxxY", "attributeDefinitionId": "0tjSG0000001embxxA", "name": "Copay", "value": 311 }, { "covBnftAttrId": "1HYSG00000002GQxxY", "attributeDefinitionId": "0tjSG0000001YmMxxU", "name": "Notes", "value": "Preferred network limitations apply." } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefits | [Benefits Input \[\]](connect_requests_plan_benefit_update_input.htm "Represents details of the plan benefits for an Insurance Policy Coverage.") | The benefits of the Insurance Plan Coverage. | Optional | 63.0 | | networks | [Networks Input \[\]](connect_requests_update_plan_benefit_network.htm "Represents Insurance Policy Coverage Networks for creating plan benefits.") | The list of networks. | Optional | 63.0 | # UpdateClaim(claimId, UpdateClaimInput) Update the details of a specific claim. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.CreateClaimOutputRepresentation UpdateClaim(String claimId, ConnectApi.ClaimInputRepresentation UpdateClaimInput) ## Parameters **claimId** - Type: String - ID of the claim to update. **UpdateClaimInput** - Type: [ConnectApi.ClaimInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_claim.htm "Input representation for creating or updating a claim.") - Details to update the claim. ## Return Value Type: [ConnectApi.CreateClaimOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_create_claim_output.htm "Output representation for a create or update claim operation.") ## Example The UpdateClaimCallable Apex class provides a way to update insurance claims by using the Connect API. **Class Definition** public with sharing class UpdateClaimCallable implements System.Callable { public Object call(String action, Map args) { Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); if (action == 'updateClaim') { ConnectApi.ClaimInputRepresentation claimInput = (ConnectApi.ClaimInputRepresentation) inputMap.get('claimInput'); System.debug('Starting Connect API call to update claim'); ConnectApi.CreateClaimOutputRepresentation claimData; try { claimData = ConnectApi.ClaimFamily.updateClaim('0Zkxx00000000BJCAY', claimInput); System.debug('Claim updated successfully: ' + claimData); outputMap.put('claimData', claimData); } catch (Exception e) { System.debug('Error updating claim: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } return claimData; } return null; } } **Usage Example** UpdateClaimCallable callable = new UpdateClaimCallable(); // Prepare input map Map input = new Map(); // Create ClaimInputRepresentation object ConnectApi.ClaimInputRepresentation claimInput = new ConnectApi.ClaimInputRepresentation(); claimInput.name = 'Claim-Demo-Test-apex-update'; claimInput.claimType = 'Auto'; claimInput.lossDate = DateTime.now(); claimInput.productCode = 'AutoClaimRoot'; claimInput.claimReasonType = 'Accident'; claimInput.claimReason = 'Damage'; claimInput.lossType = 'Repairs'; claimInput.insurancePolicyId = '0YTxx000000000iGAA'; claimInput.accountId = '001xx000003GYnoAAG'; claimInput.expenseReserveAmount = 500.00; claimInput.expenseReserveAdjustmentReason = 'Updated expense reserve'; claimInput.lossReserveAmount = 2000.00; claimInput.lossReserveAdjustmentReason = 'Updated loss reserve'; // Additional claim fields claimInput.additionalFields = new Map{ 'Severity' => 'Medium' }; // Set claim participants ConnectApi.ClaimParticipantInputRepresentation participant1 = new ConnectApi.ClaimParticipantInputRepresentation(); participant1.action = 'update'; participant1.instanceKey = 'par1'; participant1.accountId = '001xx000003GYnoAAG'; participant1.contactId = '003xx000004WhFwAAK'; participant1.insurancePolicyParticipantId = '0aoxx00000000SQAAY'; participant1.isInjured = 'false'; participant1.roles = new List{'Claimant'}; ConnectApi.ClaimParticipantInputRepresentation participant2 = new ConnectApi.ClaimParticipantInputRepresentation(); participant2.action = 'create'; participant2.instanceKey = 'par3'; participant2.contactId = '003xx000004WhFwAAK'; participant2.isInjured = 'true'; participant2.roles = new List{'Claimant', 'Involved Driver'}; claimInput.participants = new List{participant1, participant2}; // Set claim items (update or create) ConnectApi.ClaimItemInputRepresentation item1 = new ConnectApi.ClaimItemInputRepresentation(); item1.action = 'update'; item1.name = 'item1-updated'; item1.category = 'Involved Injury'; item1.productCode = 'InvolvedInjury'; item1.instanceKey = 'item1'; item1.insuredItemId = '0YWxx00000000NbGAI'; item1.insurancePolicyCoverageId = '0cYxx0000000125EAA'; item1.participantInstanceKey = 'par1'; item1.attributes = new List{ new ConnectApi.ClaimAttributeInputRepresentation('Gender', 'Male') }; item1.additionalFields = new Map{ 'Description' => null }; item1.relatedObjects = new List{ new ConnectApi.ClaimRelatedObjectInputRepresentation('001xx000003GYnoAAG', 'Account') }; ConnectApi.ClaimItemInputRepresentation item2 = new ConnectApi.ClaimItemInputRepresentation(); item2.action = 'create'; item2.name = 'item2-created'; item2.category = 'Involved Injury'; item2.productCode = 'InvolvedInjury'; item2.instanceKey = 'item2'; item2.insuredItemId = '0YWxx00000000NbGAI'; item2.insurancePolicyCoverageId = '0cYxx0000000125EAA'; item2.participantInstanceKey = 'par2'; item2.attributes = new List{ new ConnectApi.ClaimAttributeInputRepresentation('Gender', 'Male') }; item2.additionalFields = new Map{ 'Description' => 'test added' }; item2.relatedObjects = new List{ new ConnectApi.ClaimRelatedObjectInputRepresentation('001xx000003GYnoAAG', 'Account') }; claimInput.items = new List{item1, item2}; // Add claimInput to input map input.put('claimInput', claimInput); // Prepare output map Map output = new Map(); // Execute updateClaim action Map args = new Map{ 'input' => input, 'output' => output }; ConnectApi.CreateClaimOutputRepresentation claimData = (ConnectApi.CreateClaimOutputRepresentation) callable.call('updateClaim', args); // Log results System.debug('Claim Data: ' + JSON.serializePretty(claimData)); if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # UpdateClaimCoverage(claimId, coverageId, UpdateClaimCoverageInput) Update the details of a specific coverage in a claim. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.ClaimCoverageRepresentation UpdateClaimCoverage(String claimId, String coverageId, ConnectApi.UpdateClaimCoverageInputRepresentation UpdateClaimCoverageInput) ## Parameters **claimId** - Type: String - ID of the claim. **coverageId** - Type: String - ID of the claim coverage to update. **UpdateClaimCoverageInput** - Type: [ConnectApi.UpdateClaimCoverageInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_update_claim_coverage.htm "Input representation for updating a claim coverage.") - Details of the claim coverage. ## Return Value Type: [ConnectApi.ClaimCoverageRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_claim_coverage.htm "Output representation for a claim coverage operation.") ## Example The Apex example shows how to use the ConnectApi.InsuranceClaimFamily.UpdateClaimCoverage() method to update a claim coverage for an existing claim. **Class Definition** public with sharing class UpdateClaimCoverageCallable implements System.Callable { public Object call(String action, Map args) { // Retrieve the input and output maps from the arguments Map inputMap = (Map) args.get('input'); Map outputMap = (Map) args.get('output'); // Check the action type if (action == 'updateClaimCoverage') { // Retrieve the coverage input data from the input map ConnectApi.UpdateClaimCoverageInputRepresentation coverageInput = (ConnectApi.UpdateClaimCoverageInputRepresentation) inputMap.get('coverageInput'); System.debug('Start of connect API call to update claim coverage'); // Initialize the coverage output representation ConnectApi.ClaimCoverageRepresentation coverageData; // Call the Connect API to update the claim coverage try { coverageData = ConnectApi.ClaimFamily.updateClaimCoverage('0Zkxx00000000JNCAY', '0kPxx00000000RREAY', coverageInput); System.debug('Claim coverage updated successfully: ' + coverageData); // Put the coverage data in the output map outputMap.put('coverageData', coverageData); } catch (Exception e) { System.debug('Error while updating claim coverage: ' + e.getMessage()); outputMap.put('error', e.getMessage()); } // Return the coverage data return coverageData; } // If the action is not recognized, return null return null; } } **Usage Example** This example shows how to call the class and include the required input data. UpdateClaimCoverageCallable UpdateClaimCoverageCallable callable = new UpdateClaimCoverageCallable(); // Prepare the input arguments Map input = new Map(); // Create and populate the UpdateClaimCoverageInputRepresentation object ConnectApi.UpdateClaimCoverageInputRepresentation coverageInput = new ConnectApi.UpdateClaimCoverageInputRepresentation(); // Set optional fields for update coverageInput.lossReserveAmount = 30000.00; coverageInput.expenseReserveAmount = 3000.00; // Set additional fields Map additionalFields = new Map(); additionalFields.put('Description', 'Updated coverage for vehicle damage claim'); coverageInput.additionalFields = additionalFields; // Add the coverageInput to the input map input.put('coverageInput', coverageInput); // Prepare the output map Map output = new Map(); // Prepare the args map Map args = new Map(); args.put('input', input); args.put('output', output); // Call the 'updateClaimCoverage' action Object result = callable.call('updateClaimCoverage', args); // Retrieve the coverage data from the result ConnectApi.ClaimCoverageRepresentation coverageData = (ConnectApi.ClaimCoverageRepresentation) result; // Output the coverage data to the debug log System.debug('Updated Coverage Data: ' + JSON.serializePretty(coverageData)); // Check for errors in the output map if (output.containsKey('error')) { System.debug('Error: ' + output.get('error')); } # UpdateInsuranceQuoteOptions Class Contains options for updating an existing insurance quote. Use this class to control pricing execution, configuration and qualification rules, product catalog validation, and quote persistence when updating insurance quotes. ## Namespace [runtime\_industries\_insurance](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_namespace_runtime_industries_insurance.htm "The runtime_industries_insurance namespace provides Options classes to control optional input parameters for managing insurance operations, such as creating and updating insurance quotes, generating insurance clauses, and running insurance ratings. Use these classes when calling Insurance APIs from Apex to control pricing, configuration rules, qualification rules, and product catalog validation.") ## Usage Use the UpdateInsuranceQuoteOptions class when calling the [Update Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_insurance_quote.htm) invocable action to update an insurance quote so that you can specify which operations to run and whether to save the updated quote. ## Example When calling the [Update Insurance Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_update_insurance_quote.htm) invocable action from Apex, create an UpdateInsuranceQuoteOptions instance, set the desired properties, and use it as quoteOptions. // quoteOptions for updateInsuranceQuote if (inputs != null && inputs.containsKey('quoteOptions')) { Map optionsFromInput = (Map) inputs.get('quoteOptions'); if (optionsFromInput != null) { runtime\_industries\_insurance.UpdateInsuranceQuoteOptions updateQuoteOptions = new runtime\_industries\_insurance.UpdateInsuranceQuoteOptions(); Map optionsFromInput = (Map)quotePayload.get('quoteOptions'); if (optionsFromInput.containsKey('executePricing')) { updateQuoteOptions.executePricing = (Boolean)optionsFromInput.get('executePricing'); } if (optionsFromInput.containsKey('validateProductCatalog')) { updateQuoteOptions.validateProductCatalog = (Boolean)optionsFromInput.get('validateProductCatalog'); } if (optionsFromInput.containsKey('executeConfigurationRules')) { updateQuoteOptions.executeConfigurationRules = (Boolean)optionsFromInput.get('executeConfigurationRules'); } if (optionsFromInput.containsKey('executeQualificationRules')) { updateQuoteOptions.executeQualificationRules = (Boolean)optionsFromInput.get('executeQualificationRules'); } if (optionsFromInput.containsKey('saveQuote')) { updateQuoteOptions.saveQuote = (Boolean)optionsFromInput.get('saveQuote'); } action.setInvocationParameter('quoteOptions', updateQuoteOptions); } } - **[UpdateInsuranceQuoteOptions Constructors](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_constructors)** Learn more about the constructors that are available with the UpdateInsuranceQuoteOptions class. - **[UpdateInsuranceQuoteOptions Properties](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_properties)** Set the properties in the UpdateInsuranceQuoteOptions class to update an insurance quote. ## UpdateInsuranceQuoteOptions Constructors Learn more about the constructors that are available with the UpdateInsuranceQuoteOptions class. The UpdateInsuranceQuoteOptions class includes these constructors. - **[UpdateInsuranceQuoteOptions(executePricing, executeConfigurationRules, executeQualificationRules, validateProductCatalog, saveQuote)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_ctor)** Creates an options instance for quote updates with explicit control over pricing, configuration and qualification rules, catalog validation, and quote saving. - **[UpdateInsuranceQuoteOptions()](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_ctor_2)** Creates an options instance with the default settings for updating an insurance quote. ### UpdateInsuranceQuoteOptions(executePricing, executeConfigurationRules, executeQualificationRules, validateProductCatalog, saveQuote) Creates an options instance for quote updates with explicit control over pricing, configuration and qualification rules, catalog validation, and quote saving. #### Signature public UpdateInsuranceQuoteOptions(Boolean executePricing, Boolean executeConfigurationRules, Boolean executeQualificationRules, Boolean validateProductCatalog, Boolean saveQuote) #### Parameters **executePricing** - Type: Boolean - Indicates whether to execute pricing when updating the quote (true) or not (false). The default value is false. **executeConfigurationRules** - Type: Boolean - Indicates whether to run product configuration rules when updating the quote (true) or not (false). The default value is false. **executeQualificationRules** - Type: Boolean - Indicates whether to run qualification rules when updating the quote (true) or not (false). The default value is false. **validateProductCatalog** - Type: Boolean - Indicates whether to validate against the product catalog when updating the quote (true) or not (false). The default value is false. **saveQuote** - Type: Boolean - Indicates whether to save the updated quote (true) or not (false). The default value is false. ### UpdateInsuranceQuoteOptions() Creates an options instance with the default settings for updating an insurance quote. #### Signature public UpdateInsuranceQuoteOptions() ## UpdateInsuranceQuoteOptions Properties Set the properties in the UpdateInsuranceQuoteOptions class to update an insurance quote. The UpdateInsuranceQuoteOptions class includes these properties. - **[executeConfigurationRules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_executeConfigurationRules)** Indicates whether to run product configuration rules when updating the quote (true) or not (false). - **[executePricing](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_executePricing)** Indicates whether to execute pricing when updating the quote (true) or not (false). - **[executeQualificationRules](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_executeQualificationRules)** Indicates whether to run qualification rules when updating the quote (true) or not (false). - **[saveQuote](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_saveQuote)** Indicates whether to save the updated quote (true) or not (false). - **[validateProductCatalog](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_class_runtime_industries_insurance_UpdateInsuranceQuoteOptions.htm#apex_runtime_industries_insurance_UpdateInsuranceQuoteOptions_validateProductCatalog)** Indicates whether to validate against the product catalog when updating the quote (true) or not (false). ### executeConfigurationRules Indicates whether to run product configuration rules when updating the quote (true) or not (false). #### Signature public Boolean executeConfigurationRules {get; set;} #### Property Value Type: Boolean ### executePricing Indicates whether to execute pricing when updating the quote (true) or not (false). #### Signature public Boolean executePricing {get; set;} #### Property Value Type: Boolean ### executeQualificationRules Indicates whether to run qualification rules when updating the quote (true) or not (false). #### Signature public Boolean executeQualificationRules {get; set;} #### Property Value Type: Boolean ### saveQuote Indicates whether to save the updated quote (true) or not (false). #### Signature public Boolean saveQuote {get; set;} #### Property Value Type: Boolean ### validateProductCatalog Indicates whether to validate against the product catalog when updating the quote (true) or not (false). #### Signature public Boolean validateProductCatalog {get; set;} #### Property Value Type: Boolean # updateMembersWithPlans(membersWithPlansInputRepresentation, censusId) Update a family of group census members and their insurance plans in a group census in a single request. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.MembersWithPlansRepresentation updateMembersWithPlans(ConnectApi.MembersWithPlansInputRepresentation membersWithPlansInputRepresentation, String censusId) ## Parameters **membersWithPlansInputRepresentation** - Type: [ConnectApi.MembersWithPlansInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_members_with_plans.htm "Input representation for adding or updating a family of group census members and their insurance plans.") - Details of the members to update, identified by the id property of each member, along with the insurance plans to add, update, or remove for each member. **censusId** - Type: String - ID of the group census that the members belong to. ## Return Value Type: [ConnectApi.MembersWithPlansRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_members_with_plans.htm "Output representation that's returned when you add or update a family of group census members and their insurance plans.") ## Usage Use this method to update a family of group census members, along with the insurance plans for each member, in a single call. Specify the group census in censusId and the members in the members property of the input representation. Each member must specify the id of an existing GroupCensusMember record. Specify plan changes in addedPlans to add plans, in upsertedPlans to add or update plans, and in deletedPlans to remove plans by GroupCensusMemberPlan ID. The groupCensusMemberPlans property applies only when you add members with [addMembersWithPlans(membersWithPlansInputRepresentation, censusId)](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_ConnectAPI_InsuranceGroupBenefitsFamily_addMembersWithPlans.htm "Add a family of group census members and their insurance plans to a group census in a single request."). For each plan that you add or update, specify either contractGroupPlanId for a plan on the census's contract, or productCode and rootProductCode for an off-contract coverage. Check the isSuccess property of the response to determine whether the operation succeeded. Request-level errors are in the top-level errors property, which is empty when isSuccess is true. Member-specific errors are in the errors property of each item in members. ## Example Here's an example of how to update a group census member and the member's insurance plans from Apex code. Identify each member by its id property, and specify plan changes in addedPlans, upsertedPlans, and deletedPlans rather than in groupCensusMemberPlans. // Update group census members and their insurance plans in a single request. final String CENSUS\_ID = '0rfxx000000022IAAQ'; final String CGP\_TO\_UPSERT = '0rgxx00000001W3AAI'; final String CGP\_TO\_ADD = '0rgxx00000001W4AAI'; // 1) Locate the member to update. List found = \[ SELECT Id FROM GroupCensusMember WHERE GroupCensusId = :CENSUS\_ID AND FirstName = 'ApexAdd' AND Lastname = 'Primary' ORDER BY CreatedDate DESC LIMIT 1 \]; if (found.isEmpty()) { System.debug('No matching group census member found.'); return; } String memberId = found\[0\].Id; // 2) Collect the member plans to remove. List plansToDelete = new List(); for (GroupCensusMemberPlan plan : \[ SELECT Id FROM GroupCensusMemberPlan WHERE GroupCensusMemberId = :memberId LIMIT 1 \]) { plansToDelete.add(plan.Id); } // 3) Build the plans to add or update. ConnectApi.MemberPlanInputRepresentation upsertedPlan = new ConnectApi.MemberPlanInputRepresentation(); upsertedPlan.contractGroupPlanId = CGP\_TO\_UPSERT; ConnectApi.MemberPlanInputRepresentation addedPlan = new ConnectApi.MemberPlanInputRepresentation(); addedPlan.contractGroupPlanId = CGP\_TO\_ADD; // 4) Update the member details and the member's plans. ConnectApi.MemberWithPlansInputRepresentation member = new ConnectApi.MemberWithPlansInputRepresentation(); member.id = memberId; member.email = 'apexupdate.primary@example.com'; member.city = 'San Francisco'; member.state = 'CA'; member.postalCode = '94105'; member.annualEligibleSalary = 125000.00; member.smokerStatus = 'Non-Smoker'; member.upsertedPlans = new List{ upsertedPlan }; member.addedPlans = new List{ addedPlan }; member.deletedPlans = plansToDelete; ConnectApi.MembersWithPlansInputRepresentation input = new ConnectApi.MembersWithPlansInputRepresentation(); input.members = new List{ member }; try { ConnectApi.MembersWithPlansRepresentation result = ConnectApi.GroupBenefitsApi.updateMembersWithPlans(input, CENSUS\_ID); System.debug('isSuccess: ' + result.isSuccess); for (ConnectApi.MemberWithPlansRepresentation updated : result.members) { System.debug('memberId: ' + updated.memberId + ', memberPlans: ' + updated.memberPlans + ', errors: ' + updated.errors); } } catch (Exception e) { System.debug('Error while updating members with plans: ' + e.getMessage()); } # Validate API Request (POST) Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model. Use this resource at design time to pre-validate an Insurance Connect API request body before submission. Provide an API path such as insurance/quotes or insurance/product-rating, and a serialized JSON request body. The API verifies product references, hierarchy relationships, instance keys, attribute definitions, and JSON structure, and returns actionable findings for any detected issues. Validation includes these checks: - Product code existence and active status - Parent-child hierarchy structure in quoteLineItems / salesTransactionItems and nested childProducts - Non-empty instanceKey arrays in instanceKeys entries - Attribute code existence and active status against registered AttributeDefinition records - JSON parse validation for the request body string For unsupported API paths, the API returns a valid result with an informational message rather than an error. Supported paths are insurance/quotes and insurance/product-rating. When validation succeeds, isValid is true and results is empty or contains only informational findings. When validation finds issues, isValid is false and results lists the findings. When required input is missing, errors can include request-level failures such as: - SF-INS-DSAV-00041 — the request payload is required. Provide a valid JSON payload and API path. Returned with HTTP status 400 when apiPath or requestBody is missing. ## Resource /connect/insurance/design-advisor/api-request-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/api-request-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "apiPath": "insurance/quotes", "requestBody": "{"quoteLineItems":\[{"productCode":"AUTO\_POLICY","attributes":\[{"attributeCode":"DRIVER\_AGE","value":"25"},{"attributeCode":"INVALID\_ATTR","value":"X"}\],"childProducts":\[{"productCode":"COLLISION\_COVERAGE"}\]}\]}" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | apiPath | String | Path of the insurance Connect API request to validate. Supported values are insurance/quotes and insurance/product-rating. Requests for unsupported API paths return a valid response with an informational message. | Required | 68.0 | | requestBody | String | Serialized JSON string to validate. The API parses the data and checks product codes, attributes, hierarchy, and instance keys against the org’s product model. The string must be valid JSON. | Required | 68.0 | ## Response Body for POST [Insurance Request Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_request_validation.htm "Response representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation.") # Validate Attribute Definitions (POST) Validate that attribute definitions exist in the org and are active, and return resolution guidance for any attribute that can’t be validated. Use this resource at design time to confirm that attribute definitions referenced in a product model, constraint model, or request payload exist and are active. For each lookup, specify at least one of attributeId, attributeCode, or attributeName. The API resolves lookups by attribute ID, then attribute code, and then developer name, and returns results in the same order as the request. A result sets isValid to true when the attribute definition exists and IsActive is true. When the attribute is invalid, instructions contains the resolution guidance. Those per-attribute failures are returned in the response body: - SF-INS-DSAV-00030 — the attribute definition wasn’t found. - SF-INS-DSAV-00031 — the attribute definition exists but isn’t active. - SF-INS-DSAV-00032 — the lookup didn’t include an attribute ID, code, or developer name. Specify contextDefinitionId when you need to resolve dynamic context attributes, such as names that start with DYN\_\_INS\_\_, against a context definition before the API looks up AttributeDefinition records. The API resolves lookups in bulk. Regardless of how many attributes you specify, it issues at most three queries, one for each identifier type, and then matches every lookup against those results. Top-level errors are returned in errors when the request can’t be validated per attribute. A missing request body or an empty lookup list returns SF-INS-DSAV-00032 with HTTP status 400. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT\_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL\_SERVER\_ERROR with HTTP status 500. ## Resource /connect/insurance/design-advisor/attribute-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/attribute-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "contextDefinitionId": "11Oxx0000004CXqEAM", "attributeLookups": \[ { "attributeId": "0QPxx0000004CAAQ" }, { "attributeCode": "Make" }, { "attributeName": "Vehicle\_Model" }, { "attributeCode": "SF-INS-DSAV-00032" }, {} \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | attributeLookups | [Insurance Attribute Input](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_requests_ins_attribute_input.htm "Input representation of one attribute definition to validate. Specify at least one of attribute ID, attribute code, or developer name.")\[\] | Attribute definitions to validate. Each entry identifies one attribute definition by ID, code, or developer name. The API confirms that each definition exists in the org and is active. Results are returned in the same order as this list. | Required | 68.0 | | contextDefinitionId | String | ID of the context definition. When you specify this ID, dynamic context attributes, such as attributes whose names start with DYN\_\_INS\_\_, are resolved against that context definition’s dynamic-attributes catalog before the API looks up AttributeDefinition records. | Optional | 68.0 | ## Response Body for POST [Insurance Attribute Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_attribute_validation.htm "Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn’t.") # Validate CML Model (POST) Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent. Use this resource at design time to verify CML model integrity for Digital Insurance products. Provide a required list of product IDs and optional lists of product surcharge, insurance product clause, and underwriting rule IDs. The API checks that an active CML model exists for each product and that each related record’s product path or rule key is correctly declared in the active CML. Validations include confirming that an active constraint expression set is associated with each root product; that surcharge and clause product paths are present in the CML association when no rule key is set; that rule keys for surcharges, clauses, and underwriting rules are declared in an active CML body; and that each referenced surcharge, clause, and underwriting rule record exists. An underwriting rule with a blank rule key is treated as a BRE-based rule and marked valid with an informational instruction. When every record passes validation, isValid is true. When one or more records fail, isValid is false and results lists each record with its outcome. Per-record failures are returned in the response body with HTTP status 200. Examples include: - SF-INS-DSAV-00034 — no active CML model is associated with the product. - SF-INS-DSAV-00035 — the record’s product path is empty. - SF-INS-DSAV-00036 — one or more products in the product path aren’t referenced by the active CML model. - SF-INS-DSAV-00037 — the specified record wasn’t found. - SF-INS-DSAV-00039 — the record’s rule key isn’t declared in any active CML model. Top-level errors are returned in errors when the request can’t be validated per record. A missing or empty productIds list returns SF-INS-DSAV-00033 with HTTP status 400. Insufficient access, or Design Advisor not enabled for the org, returns HTTP status 403. An unexpected failure returns HTTP status 500. ## Resource /connect/insurance/design-advisor/cml-model-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/cml-model-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productIds": \["01txx0000006iPnAAI"\], "productSurchargeIds": \["0nSxx0000001DDDAAI"\], "productClauseIds": \["0nPxx0000001EEEAAI"\], "underwritingRuleIds": \["0nUxx0000001FFFAAI"\] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productClauseIds | String\[\] | List of insurance product clause IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | | productIds | String\[\] | List of root product IDs to be validated. For each ID, the API verifies that the product has an active CML model associated with it. | Required | 68.0 | | productSurchargeIds | String\[\] | List of product surcharge IDs to validate against the active CML model that’s identified by productIds. For each surcharge, the API checks whether the record exists, and whether every segment of its ProductPath is referenced by the active CML association. Don’t specify this property if you don’t want to validate surcharges for the products. | Optional | 68.0 | | underwritingRuleIds | String\[\] | List of underwriting rule IDs to validate against the active CML model identified by productIds. | Optional | 68.0 | ## Response Body for POST [Insurance CML Model Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_cml_model_validation.htm "Output representation of the per-record validation results and any top-level errors that occur when processing the request.") # Validate Group Census Members Action Validate the specified group census member records and assign default values to the specified fields. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/validateGroupCensusMembers Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | duplicateDetectionKeysList | string | Comma-separated list of field names that are used to identify the unique group census member records. For example, FirstName , LastName , GroupCensusId , and AssociationWithPrimaryMbr . | | groupCensusId | string | ID of the parent group census record that's associated with the group census member records. | | groupCensusMembers | sobject | Collection of group census member records that must be validated. Maximum list size is 2000. | ## Outputs | Output | Type | Description | | --- | --- | --- | | errorsData | Apex-defined | Details of the validation errors that occurred while validating the group census member records. Maximum limit is 2000. | | validatedGroupCensusMembers | sobject | Collection of group census member records that are validated and assigned with default values. Records with validation errors aren't shown. Maximum limit is 2000. | ## Example Sample Request { "inputs": \[ { "groupCensusId": "0rfDR0000000Cn6YAE", "groupCensusMembers": \[ { "Name": "RossFarley", "FirstName": "Ross", "Lastname": "Farley", "Gender": "Male", "GroupClassName": "Manager", "Email": "ross.farley\_0001@insgroup.co.in", "AssociationWithPrimaryMbr": "Self" }, { "Name": "Fakeem Huber", "FirstName": "Fakeem", "Lastname": "Huber", "Gender": "Male", "GroupClassName": "Associate", "Email": "fakeem.huber\_0432@insgroup.co.in", "AssociationWithPrimaryMbr": "Self" } \] } \] } Sample Response { "validatedGroupCensusMembers": \[ { "attributes": { "type": "GroupCensusMember" }, "Email": "ross.farley\_0001@insgroup.co.in", "AssociationWithPrimaryMbr": "Self", "FirstName": "Ross", "MemberKey": "a66e329bd537b9b0be9d04f326eeed94", "RelationshipToPrimaryMember": "Self", "Lastname": "Farley", "Gender": "Male", "GroupClassId": "0rEDR000000085k2AA", "GroupCensusId": "0rfDR0000000Cn6YAE", "Name": "RossFarley" }, { "attributes": { "type": "GroupCensusMember" }, "Email": "fakeem.huber\_0432@insgroup.co.in", "AssociationWithPrimaryMbr": "Self", "FirstName": "Fakeem", "MemberKey": "fa26049af8a10b70bd68ce9a6912425f", "RelationshipToPrimaryMember": "Self", "Lastname": "Huber", "Gender": "Male", "GroupClassId": "0rEDR000000085p2AA", "GroupCensusId": "0rfDR0000000Cn6YAE", "Name": "Fakeem Huber" } \] } # Validate Group Census Members Plans Action Validate the specified group census member plan records and assign default values to the specified fields. This action is available in API version 66.0 and later. ## Special Access Rules To use this invocable action, you must have Digital Insurance Group Benefits Census Management user access and the org must be enabled with the Digital Insurance Group Benefits feature. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/validateGrpCensusMembersPlans Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs You must specify one of these input parameters for the validation process. - contextId - groupCensusMembers - memberPlansToDelete - memberPlansToValidate | Input | Type | Description | | --- | --- | --- | | contextId | string | ID of the context definition that contains information about root plans and coverages that are configured for the current list of group census members. | | groupCensusMembers | sobject | Group census member records that must be validated. | | memberPlansToDelete | sobject | Group census member plan records that must be deleted. | | memberPlansToValidate | sobject | Group census member plan records that must be validated. | | shouldExecuteConfigurationRule | boolean | Indicates whether the product configuration rules must be executed for member plans in the enrollment census ( true ) or not ( false ). | ## Outputs | Output | Type | Description | | --- | --- | --- | | errorsData | Apex-defined | Validation errors that occurred while validating the group census member and plans records. | | validatedGroupCensusMemberPlans | sobject | Group census member plan records that are validated and assigned with default values. | | validatedGroupCensusMembers | sobject | Group census member records that are validated and assigned with default values. | ## Example **POST** This sample request is for the Validate Group Census Members Plans action. { "inputs": \[ { "groupCensusMembers": \[ { "Id": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001", "FirstName": "John", "LastName": "Doe", "GroupCensus": "gc\_12345" }, { "Id": "b2c3d4e5f6g7h8i9", "MemberRefId": "M002", "FirstName": "Jane", "LastName": "Smith", "GroupCensus": "gc\_12345" } \], "memberPlansToValidate": \[ { "ContractGroupPlan": "plan\_medical\_001", "GroupCensusMember": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001" }, { "ContractGroupPlan": "plan\_dental\_001", "GroupCensusMember": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001" } \], "memberPlansToDelete": \[ { "ContractGroupPlan": "plan\_old\_001", "GroupCensusMember": "b2c3d4e5f6g7h8i9", "MemberRefId": "M002" } \], "contextId": "ctx\_validation\_12345", "shouldExecuteConfigurationRule": true } \] } This sample response is for the Validate Group Census Members Plans action. { "outputs": \[ { "validatedGroupCensusMembers": \[ { "Id": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001", "FirstName": "John", "LastName": "Doe", "Information": "Plans validated successfully", "CensusMgmtUploadMemError": null }, { "Id": "b2c3d4e5f6g7h8i9", "MemberRefId": "M002", "FirstName": "Jane", "LastName": "Smith", "Information": "Plan deletion validated", "CensusMgmtUploadMemError": null } \], "validatedGroupCensusMemberPlans": \[ { "ContractGroupPlan": "plan\_medical\_001", "GroupCensusMember": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001", "PlanType": "AUTO\_ADDED" }, { "ContractGroupPlan": "plan\_dental\_001", "GroupCensusMember": "a1b2c3d4e5f6g7h8", "MemberRefId": "M001", "PlanType": "AUTO\_ADDED" }, { "ContractGroupPlan": "plan\_old\_001", "GroupCensusMember": "b2c3d4e5f6g7h8i9", "MemberRefId": "M002", "CensusMgmtUploadMemError": "Plan successfully marked for deletion" } \], "errorsData": \[\] } \] } # Validate Pricing Setup (POST) Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. Use this resource at design time to confirm that pricing infrastructure is correctly configured before quote execution or product rating. Provide an optional quote ID, transaction type, and product IDs. The API validates procedure plans, pricing procedures, effective dates, and context definitions for the specified transaction. When quoteId or transactionType is provided, quote-level checks confirm that the transaction type is valid and resolvable; that a quote-level procedure plan is defined; that procedure plan effective dates cover the quote’s date range; that the quote-level pricing procedure has an active version for the evaluation date; and that the procedure plan’s context definition is a valid Insurance context. When productIds is provided, product-level checks confirm that a product-level procedure plan is defined for each product, that the product-level pricing procedure has an active version for the evaluation date, and that the product procedure plan’s context definition is a valid Insurance context. When pricing setup is valid, isValid is true. When setup fails, isValid is false and errors lists the failures. Pricing setup failures are returned in the response body with HTTP status 200. Examples include: - SF-INS-DSAV-00062 — the transaction type isn’t valid or couldn’t be resolved. - SF-INS-DSAV-00063 — no quote-level procedure plan is defined for the transaction type. - SF-INS-DSAV-00064 — procedure plan effective dates aren’t valid for the request. - SF-INS-DSAV-00066 — no product-level procedure plan is defined for a submitted product. - SF-INS-DSAV-00067 — the quote-level pricing procedure doesn’t have an active version for the evaluation date. - SF-INS-DSAV-00068 — the product-level pricing procedure doesn’t have an active version for the evaluation date. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT\_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL\_SERVER\_ERROR with HTTP status 500. ## Resource /connect/insurance/design-advisor/pricing-setup-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/pricing-setup-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "quoteId": "0Q0xx0000006iPnAAI", "productIds": \["01txx0000006iPnAAI", "01txx0000006iPmAAI"\] } ### Properties Provide at least one of quoteId, transactionType, or productIds for meaningful validation. If none are provided, the API returns isValid as true with no errors. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productIds | String\[\] | List of Product2 record IDs to validate for product-level procedure plan configuration. | Optional | 68.0 | | quoteId | String | Quote record ID. When provided, the quote’s transaction type and date context are used for quote-level validation. | Optional | 68.0 | | transactionType | String | Transaction type developer name. Used for quote-level validation when quoteId isn’t provided, or to override the quote’s transaction type. | Optional | 68.0 | ## Response Body for POST [Insurance Pricing Setup Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_pricing_setup_validation.htm "Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors.") # Validate Product Discovery (POST) Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. Use this resource at design time to confirm that a product’s discovery-related setup is correct before runtime product discovery. Provide a product ID, product code, or developer name. The API resolves the target product and validates pricing, price book entries, and selling model configurations that would otherwise surface as failures during discovery. Validations include confirming that at least one product identifier is provided; that the product exists; that an active price book entry with a unit price greater than zero is associated with an active price book; and that the product is associated with an active product selling model option. When the Select Pricing Procedure preference is enabled, the API also checks that a product discovery pricing procedure is configured with an active version, that an active decision table with source object PricebookEntry exists, and that the product’s price book entry can be resolved by that decision table. When the discovery setup is valid, isValid is true. When setup fails, isValid is false and errors parameter includes the failure details. Discovery setup failures are returned in the response body with HTTP status 200. Examples include: - SF-INS-DSAV-00011 — the product doesn’t have a price book entry. - SF-INS-DSAV-00004 — the product isn’t associated with a product selling model option. - SF-INS-DSAV-00040 — the product discovery pricing procedure isn’t configured. - SF-INS-DSAV-00047 — no active decision table with source object PricebookEntry was found. - SF-INS-DSAV-00046 — the product’s price book entries aren’t included in any active decision table. Request-level failures are also returned in errors. A missing product identifier returns SF-INS-DSAV-00038 with HTTP status 400. A product that can’t be found returns SF-INS-DSAV-00044 with HTTP status 400. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT\_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL\_SERVER\_ERROR with HTTP status 500. Informational messages appear in infos. For example, SF-INS-DSAV-00042 indicates that pricing is disabled for product discovery and pricing procedure validation was skipped, and SF-INS-DSAV-00043 reminds you to refresh decision tables after recent changes. ## Resource /connect/insurance/design-advisor/product-discovery-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/product-discovery-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productId": "01txx0000006iPnAAI" } ### Properties Specify at least one of productId, productCode, or productName. If none is provided, validation fails with error code SF-INS-DSAV-00038. | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productCode | String | Product code used to look up the insurance product to validate for discovery setup. | Required if productId and productName aren’t specified | 68.0 | | productId | String | Product2 ID of the insurance product to validate for discovery setup. | Required if productCode and productName aren’t specified | 68.0 | | productName | String | Developer name used to look up the insurance product to validate for discovery setup. | Required if productId and productCode aren’t specified | 68.0 | ## Response Body for POST [Insurance Product Discovery Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_discovery_validation.htm "Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages.") # Validate Product Model (POST) Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. Use this resource at design time to validate a root insurance product and every associated product in its hierarchy, including direct children, component groups, and classification-based children. The API checks configuration that would otherwise surface as runtime failures during quoting, rating, or policy issuance. Validations include confirming that each product is active; that the product code is specified, is a single word, and is unique; that an active record type and product specification record type mapping are present; that root-level product type is Base, Bundle, or Set; that BasedOnId points to a valid product classification; that an active product selling model and price book entry are associated; that attribute definitions have non-blank developer names and unique codes; that extended attribute reference object and field are set together and resolve in metadata; that the root product is associated with a catalog category; and that the hierarchy has no cycles or forbidden parent-child specification-type pairings. When every product in the hierarchy passes validation, isValid is true. When one or more products fail, isValid is false and products lists the related products that have configuration errors. Those per-product failures are returned in the response body with HTTP status 200. Examples include: - SF-INS-DSAV-00001 — the product isn’t active. - SF-INS-DSAV-00004 — the product isn’t associated with a product selling model option. - SF-INS-DSAV-00011 — the product doesn’t have a price book entry. - SF-INS-DSAV-00014 — the product doesn’t have a record type assigned. - SF-INS-DSAV-00027 — the product hierarchy contains a circular reference. Top-level errors are returned in errors when the request can’t be validated per product. A missing productId returns SF-INS-DSAV-00013. A blank, malformed, or invalid Product2 ID returns SF-INS-DSAV-00012. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT\_ACCESS with HTTP status 403. An unexpected failure returns INTERNAL\_SERVER\_ERROR with HTTP status 500. ## Resource /connect/insurance/design-advisor/product-model-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/product-model-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "productId": "01txx0000006iPnAAI" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the root insurance product for which you want to validate the model setup. The API validates this product and all associated products in its hierarchy, including direct children, component groups, and classification-based children. | Required | 68.0 | ## Response Body for POST [Insurance Product Model Validation Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_product_model_validation.htm "Output representation of the validation results for a product model and its hierarchy.") # Validate User Permissions (POST) Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy. If the user isn’t authorized to perform the specified action, the API returns the validation status along with troubleshooting guidance. Use this resource at design time to confirm that a user can perform a given insurance operation before guiding them through a setup flow. Provide a targetOperation value such as executeQuote, browseCatalog, or createPolicy. Optionally set userId. If userId isn't specified, the API checks the current running user. The API resolves org-level and user-level access checks for the operation. When the user is permitted, isValid is true. When a check fails, isValid is false and instructions names the missing permission set or lists supported operation identifiers. Examples include: - Unsupported or blank targetOperation — returns invalid with the list of supported values. - Missing policy admin access for quote or policy operations — for example, assign DigitalInsurancePolicyAdminUser. - Missing product admin access for catalog, rating, surcharge, underwriting rule, or clause operations — for example, assign DigitalInsuranceProductAdmin or DigitalInsuranceRunTimeProductAdmin. ## Resource /connect/insurance/design-advisor/user-permissions-validation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/user-permissions-validation ## Available Version 68.0 ## HTTP Methods POST ## Request Body for POST ### JSON Example { "targetOperation": "createPolicy", "userId": "005xx000001X7roAAC" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | targetOperation | String | Insurance operation to validate against the user’s permission. Valid values are: executeQuote, browseCatalog, createQuote, rateProduct, createPolicy, endorsePolicy, cancelPolicy, reinstatePolicy, createSurcharge, createUnderwritingRules, and createClause. Unknown or blank values return an invalid result with the list of supported identifiers. | Required | 68.0 | | userId | String | ID of the user to check the permission for. If not specified, the API validates permission for the current user. | Optional | 68.0 | ## Response Body for POST [Insurance Validate User Permissions Response](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_ins_validate_user_permissions.htm "Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t.") # validateApiRequest(insRequestValidationInputRepresentation) Validate a JSON request body for the Insurance Quote or Insurance Product Rating API by checking product codes, attributes, instance keys, and required fields against the configured product model. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsRequestValidationRepresentation validateApiRequest(ConnectApi.InsRequestValidationInputRepresentation insRequestValidationInputRepresentation) ## Parameters insRequestValidationInputRepresentation Type: [ConnectApi.InsRequest​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_request_validation.htm "Input representation that specifies the insurance Connect API path and serialized JSON request body to validate against the product model.") Required. Input that specifies the insurance Connect API path and the serialized JSON request body to validate. ## Return Value Type: [ConnectApi.InsRequest​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_request_validation.htm "Output representation that contains the overall request validation result, individual findings, and any request-level errors that prevented validation.") ## Usage Use this method at design time to pre-validate an Insurance Connect API request body before submission. Provide an API path such as insurance/quotes or insurance/product-rating, and a serialized JSON request body. The method verifies product references, hierarchy relationships, instance keys, attribute definitions, and JSON structure, and returns actionable findings for any detected issues. Validation includes these checks: - Product code existence and active status - Parent-child hierarchy structure in quoteLineItems / salesTransactionItems and nested childProducts - Non-empty instanceKey arrays in instanceKeys entries - Attribute code existence and active status against registered AttributeDefinition records - JSON parse validation for the request body string For unsupported API paths, the method returns a valid result with an informational message rather than an error. Supported paths are insurance/quotes and insurance/product-rating. When validation succeeds, isValid is true and results is empty or contains only informational findings. When validation finds issues, isValid is false and results lists the findings. When required input is missing, errors can include request-level failures such as: - SF-INS-DSAV-00041 — the request payload is required. Provide a valid JSON payload and API path. ## Example This sample validates an API request payload from Apex. ConnectApi.InsRequestValidationInputRepresentation input = new ConnectApi.InsRequestValidationInputRepresentation(); input.apiPath = 'insurance/product-rating'; input.requestBody = '{"ratingInputs":\[{"productCode":"autoSilver"}\]}'; ConnectApi.InsRequestValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateApiRequest(input); System.debug('isValid=' + result.isValid); System.debug('results=' + result.results); System.debug('errors=' + result.errors); # validateAttributes(insAttributeValidationInputRepresentation) Validate that the specified attribute definitions exist in the org and are active. This method returns a per-attribute validation status with resolution guidance for any attribute that can't be validated. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsAttributeValidationRepresentation validateAttributes(ConnectApi.InsAttributeValidationInputRepresentation insAttributeValidationInputRepresentation) ## Parameters insAttributeValidationInputRepresentation Type: [ConnectApi.InsAttribute​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_attribute_validation.htm "Input representation of the attribute definitions to validate. Each lookup identifies one attribute definition by ID, code, or developer name.") Required. List of attribute definitions to validate. Identify each attribute by ID, code, or developer name. The method confirms that each definition exists in the org and is active, and returns resolution guidance for any attribute that can't be validated. Specify a context definition ID when you need to resolve dynamic context attributes. ## Return Value Type: [ConnectApi.InsAttribute​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_attribute_validation.htm "Output representation of the per-attribute validation results. Each result reports whether the attribute definition exists and is active, and includes resolution guidance when it isn't.") ## Usage Use this method at design time to confirm that attribute definitions referenced in a product model, constraint model, or request payload exist in the org and are active. You can directly call this method or use this method from the Insurance Design Advisor agent to check the validity of the attribute definitions, before the attribute definitions are used. For each attribute lookup, the method checks that at least one of attributeId, attributeCode, or attributeName is provided, that an AttributeDefinition record exists, and that the record is active (IsActive is true). Lookups are resolved by attribute ID, then attribute code, and then developer name. Each result sets isValid to true when the attribute definition is valid. When the attribute is invalid, instructions contains the resolution guidance. Per-attribute failures use these error codes: - SF-INS-DSAV-00030 — the attribute definition wasn't found. - SF-INS-DSAV-00031 — the attribute definition is inactive. - SF-INS-DSAV-00032 — the lookup didn't include an attribute ID, code, or developer name. The method resolves lookups in bulk. Regardless of how many attributes you specify, the method issues at most three queries, one for each identifier type, and then matches every lookup in memory against those results. ## Example This is a sample code to validate an attribute definition from Apex. ConnectApi.InsAttributeInputRepresentation attr = new ConnectApi.InsAttributeInputRepresentation(); attr.attributeName = 'Limit'; ConnectApi.InsAttributeValidationInputRepresentation input = new ConnectApi.InsAttributeValidationInputRepresentation(); input.attributeLookups = new List{ attr }; ConnectApi.InsAttributeValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateAttributes(input); System.debug('isValid=' + result.isValid); System.debug('attributes=' + result.attributes); System.debug('errors=' + result.errors); # validateCMLModel(insCMLModelValidationInputRepresentation) Validate the active CML (Constraint Markup Language) model for the specified insurance products and related records. Returns validation status for each specified record along with resolution guidance when the CML configuration is incomplete or inconsistent. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsCMLModelValidationRepresentation validateCMLModel(ConnectApi.InsCMLModelValidationInputRepresentation insCMLModelValidationInputRepresentation) ## Parameters insCMLModelValidationInputRepresentation Type: [ConnectApi.InsCML​Model​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_cml_model_validation.htm "Input representation of the insurance products and related records to validate against the active CML model.") Required. Input that identifies the root products to validate and optional related surcharge, clause, and underwriting rule records to check against the active CML model. ## Return Value Type: [ConnectApi.InsCML​Model​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_cml_model_validation.htm "Output representation of the per-record validation results and any top-level errors that occur when processing the request.") ## Usage Use this method at design time to verify CML model integrity for Digital Insurance products. Provide a required list of product IDs and optional lists of product surcharge, insurance product clause, and underwriting rule IDs. The method checks that an active CML model exists for each product and that each related record’s product path or rule key is correctly declared in the active CML. Validations include confirming that an active constraint expression set is associated with each root product; that surcharge and clause product paths are present in the CML association when no rule key is set; that rule keys for surcharges, clauses, and underwriting rules are declared in an active CML body; and that each referenced surcharge, clause, and underwriting rule record exists. An underwriting rule with a blank rule key is treated as a BRE-based rule and marked valid with an informational instruction. When every record passes validation, isValid is true. When one or more records fail, isValid is false and results lists each record with its outcome. Per-record failures appear in results, not in errors. Examples include: - SF-INS-DSAV-00034 — no active CML model is associated with the product. - SF-INS-DSAV-00035 — the record’s product path is empty. - SF-INS-DSAV-00036 — one or more products in the product path aren’t referenced by the active CML model. - SF-INS-DSAV-00037 — the specified record wasn’t found. - SF-INS-DSAV-00039 — the record’s rule key isn’t declared in any active CML model. Top-level errors are returned in errors when the request can’t be validated per record. A missing or empty productIds list returns SF-INS-DSAV-00033. ## Example This sample validates a CML model from Apex. ConnectApi.InsCMLModelValidationInputRepresentation input = new ConnectApi.InsCMLModelValidationInputRepresentation(); input.productIds = new List{ '01txx0000006i3DAAQ' }; input.productSurchargeIds = new List{ '1Xrxx0000000001CAA' }; ConnectApi.InsCMLModelValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateCMLModel(input); System.debug('isValid=' + result.isValid); System.debug('results=' + result.results); System.debug('errors=' + result.errors); # validatePricingSetup(insPricingSetupValidationInputRepresentation) Validate pricing configuration, including transaction type resolution, procedure plan existence and effective dates, pricing procedure versions, and the context definition. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsPricingSetupValidationRepresentation validatePricingSetup(ConnectApi.InsPricingSetupValidationInputRepresentation insPricingSetupValidationInputRepresentation) ## Parameters insPricingSetupValidationInputRepresentation Type: [ConnectApi.InsPricing​Setup​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_pricing_setup_validation.htm "Input representation of the quote, transaction type, and products to validate for pricing setup configuration.") Required. Input that optionally identifies a quote, transaction type, and product IDs to validate for pricing setup configuration. ## Return Value Type: [ConnectApi.InsPricing​Setup​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_pricing_setup_validation.htm "Output representation of the pricing setup validation result, including whether the pricing configuration is valid and any related errors.") ## Usage Use this method at design time to confirm that pricing infrastructure is correctly configured before quote execution or product rating. Provide an optional quote ID, transaction type, and product IDs. The method validates procedure plans, pricing procedures, effective dates, and context definitions for the specified transaction. When quoteId or transactionType is provided, quote-level checks confirm that the transaction type is valid and resolvable; that a quote-level procedure plan is defined; that procedure plan effective dates cover the quote’s date range; that the quote-level pricing procedure has an active version for the evaluation date; and that the procedure plan’s context definition is a valid Insurance context. When productIds is provided, product-level checks confirm that a product-level procedure plan is defined for each product, that the product-level pricing procedure has an active version for the evaluation date, and that the product procedure plan’s context definition is a valid Insurance context. When pricing setup is valid, isValid is true. When setup fails, isValid is false and errors lists the failures. Examples include: - SF-INS-DSAV-00062 — the transaction type isn’t valid or couldn’t be resolved. - SF-INS-DSAV-00063 — no quote-level procedure plan is defined for the transaction type. - SF-INS-DSAV-00064 — procedure plan effective dates aren’t valid for the request. - SF-INS-DSAV-00066 — no product-level procedure plan is defined for a submitted product. - SF-INS-DSAV-00067 — the quote-level pricing procedure doesn’t have an active version for the evaluation date. - SF-INS-DSAV-00068 — the product-level pricing procedure doesn’t have an active version for the evaluation date. ## Example This sample validates pricing setup from Apex. ConnectApi.InsPricingSetupValidationInputRepresentation input = new ConnectApi.InsPricingSetupValidationInputRepresentation(); input.productIds = new List{ '01txx0000006i3DAAQ' }; ConnectApi.InsPricingSetupValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validatePricingSetup(input); System.debug('isValid=' + result.isValid); System.debug('errors=' + result.errors); # validateProductDiscovery(insProductDiscoveryValidationInputRepresentation) Validate that a product is discoverable at runtime by checking price book entries, selling models, pricing procedures, and decision table configurations. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsProductDiscoveryValidationRepresentation validateProductDiscovery(ConnectApi.InsProductDiscoveryValidationInputRepresentation insProductDiscoveryValidationInputRepresentation) ## Parameters insProductDiscoveryValidationInputRepresentation Type: [ConnectApi.InsProduct​Discovery​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_product_discovery_validation.htm "Input representation of the product to validate for discovery setup. Identify the product by ID, product code, or developer name.") Required. Input that identifies the insurance product to validate for discovery setup. Provide at least one of product ID, product code, or developer name. ## Return Value Type: [ConnectApi.InsProduct​Discovery​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_discovery_validation.htm "Output representation of the product discovery validation result, including whether the product’s discovery setup is valid and any related errors or informational messages.") ## Usage Use this method at design time to confirm that a product’s discovery-related setup is correct before runtime product discovery. The method resolves the target product from the provided identifier and validates pricing, price book entries, and selling model configurations that would otherwise surface as failures during discovery. Validations include confirming that at least one product identifier is provided; that the product exists; that an active price book entry with a unit price greater than zero is associated with an active price book; and that the product is associated with an active product selling model option. When the Select Pricing Procedure preference is enabled, the method also checks that a product discovery pricing procedure is configured with an active version, that an active decision table with source object PricebookEntry exists, and that the product’s price book entry can be resolved by that decision table. When the discovery setup is valid, isValid is true. When setup fails, isValid is false and errors lists the failures. Examples include: - SF-INS-DSAV-00038 — no product identifier was provided. - SF-INS-DSAV-00044 — no product was found for the specified identifier. - SF-INS-DSAV-00011 — the product doesn’t have a price book entry. - SF-INS-DSAV-00004 — the product isn’t associated with a product selling model option. - SF-INS-DSAV-00040 — the product discovery pricing procedure isn’t configured. - SF-INS-DSAV-00047 — no active decision table with source object PricebookEntry was found. Informational messages can appear in infos. For example, SF-INS-DSAV-00042 indicates that pricing is disabled for product discovery and pricing procedure validation was skipped, and SF-INS-DSAV-00043 reminds you to refresh decision tables after recent changes. ## Example This sample validates product discovery setup from Apex. ConnectApi.InsProductDiscoveryValidationInputRepresentation input = new ConnectApi.InsProductDiscoveryValidationInputRepresentation(); input.productId = '01txx0000006i3DAAQ'; ConnectApi.InsProductDiscoveryValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateProductDiscovery(input); System.debug('isValid=' + result.isValid); System.debug('errors=' + result.errors); System.debug('infos=' + result.infos); # validateProductModel(insProductModelValidationInputRepresentation) Validate the setup and configuration of insurance product models at design time. Provide a root product ID to check the entire product hierarchy for configuration errors that could cause failures during quoting, rating, or policy issuance. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsProductModelValidationRepresentation validateProductModel(ConnectApi.InsProductModelValidationInputRepresentation insProductModelValidationInputRepresentation) ## Parameters insProductModelValidationInputRepresentation Type: [ConnectApi.InsProduct​Model​Validation​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_product_model_validation.htm "Input representation of the details to validate an insurance product model.") Required. Input that identifies the root insurance product whose model setup should be validated. The method validates this product and all associated products in its hierarchy, including direct children, component groups, and classification-based children. ## Return Value Type: [ConnectApi.InsProduct​Model​Validation​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_product_model_validation.htm "Output representation of the validation results for a product model and its hierarchy.") ## Usage Use this method at design time to validate a root insurance product and every associated product in its hierarchy, including direct children, component groups, and classification-based children. The method checks configuration that would otherwise surface as runtime failures during quoting, rating, or policy issuance. Validations include confirming that each product is active; that the product code is specified, is a single word, and is unique; that an active record type and product specification record type mapping are present; that root-level product type is Base, Bundle, or Set; that BasedOnId points to a valid product classification; that an active product selling model and price book entry are associated; that attribute definitions have non-blank developer names and unique codes; that extended attribute reference object and field are set together and resolve in metadata; that the root product is associated with a catalog category; and that the hierarchy has no cycles or forbidden parent-child specification-type pairings. When every product in the hierarchy passes validation, isValid is true. When one or more products fail, isValid is false and products lists the related products that have configuration errors. Examples of per-product error codes include: - SF-INS-DSAV-00001 — the product isn’t active. - SF-INS-DSAV-00004 — the product isn’t associated with a product selling model option. - SF-INS-DSAV-00011 — the product doesn’t have a price book entry. - SF-INS-DSAV-00014 — the product doesn’t have a record type assigned. - SF-INS-DSAV-00027 — the product hierarchy contains a circular reference. Top-level errors are returned in errors when the request can’t be validated per product. A missing productId returns SF-INS-DSAV-00013. A blank, malformed, or invalid Product2 ID returns SF-INS-DSAV-00012. Insufficient access, or Digital Insurance not enabled for the org, returns INSUFFICIENT\_ACCESS. ## Example This sample validates a product model from Apex. ConnectApi.InsProductModelValidationInputRepresentation input = new ConnectApi.InsProductModelValidationInputRepresentation(); input.productId = '01txx0000006i3DAAQ'; ConnectApi.InsProductModelValidationRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateProductModel(input); System.debug('isValid=' + result.isValid); System.debug('productId=' + result.productId); System.debug('products=' + result.products); System.debug('errors=' + result.errors); System.debug('infos=' + result.infos); # validateUserPermissions(insValidateUserPermissionsInputRepresentation) Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy, and return troubleshooting guidance when the user isn’t authorized. ## API Version 68.0 ## Requires Chatter No ## Signature public static ConnectApi.InsValidateUserPermissionsRepresentation validateUserPermissions(ConnectApi.InsValidateUserPermissionsInputRepresentation insValidateUserPermissionsInputRepresentation) ## Parameters insValidateUserPermissionsInputRepresentation Type: [ConnectApi.InsValidate​User​Permissions​InputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_ins_validate_user_permissions.htm "Input representation that specifies the insurance operation and optional user ID for a permissions check.") Required. Input representation of the insurance operation to validate and, optionally, the user ID to check. ## Return Value Type: [ConnectApi.InsValidate​User​Permissions​Representation](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_ins_validate_user_permissions.htm "Output representation that indicates whether the user has the required permissions for the requested insurance operation, and remediation guidance when they don’t.") ## Usage Use this method at design time to confirm that a user can perform a given insurance operation before guiding them through a setup flow. Provide a targetOperation value such as executeQuote, browseCatalog, or createPolicy. Optionally set userId. If userId isn't specified, the method validates permission for the current running user. The method resolves org-level and user-level access checks for the operation. When the user is permitted, isValid is true. When a check fails, isValid is false and instructions includes the missing permission set or lists supported operation identifiers. Examples include: - Unsupported or blank targetOperation — returns invalid with the list of supported values. - Missing policy admin access for quote or policy operations — for example, assign DigitalInsurancePolicyAdminUser. - Missing product admin access for catalog, rating, surcharge, underwriting rule, or clause operations — for example, assign DigitalInsuranceProductAdmin or DigitalInsuranceRunTimeProductAdmin. ## Example This sample validates user permissions from Apex. ConnectApi.InsValidateUserPermissionsInputRepresentation input = new ConnectApi.InsValidateUserPermissionsInputRepresentation(); input.targetOperation = 'createQuote'; // required input.userId = '005xx000001X7roAAC'; // optional; defaults to running user ConnectApi.InsValidateUserPermissionsRepresentation result = ConnectApi.InsuranceDesignAdvisorFamily.validateUserPermissions(input); System.debug('isValid=' + result.isValid); System.debug('instructions=' + result.instructions); # Verify Policy Coverage Output representation of a policy coverage's applicability for a specified loss date under an insurance policy. ## JSON Example { "isSuccess": true, "errors": \[\] } | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errors | [Error Detail](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_error_details.htm "Output representation of the error details.")\[\] | List of errors, including detailed information about each one. | Big, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the policy coverage is valid for the date on which the incident occurred (true) or not (false). | Big, 65.0 | 65.0 | # Verify Policy Coverage (POST) Verify the applicability of a policy coverage for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. ## Resource {policyId} and {coverageId} are placeholders. /connect/insurance/policies/{policyId}/coverages/{coverageId}/verify ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTx0000000001qEAA/coverages/0cYx0000000002fEAA/verify ## Available Version 65.0 ## HTTP Methods POST ## Path Parameter for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | policyId | String | ID of the insurance policy that the coverage belongs to. | Required | 65.0 | | coverageId | String | ID of the coverage within the insurance policy to verify the details for. | Required | 65.0 | ## Request Body for POST ### JSON Example { "lossDate": "2025-09-13", "insuredAssetOrParticipantId": "0kaxx000000001dEAA" } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insuredAsset​Or​ParticipantId | String | ID of the insured asset or participant that's related to the policy coverage. | Required | 65.0 | | lossDate | String | Date on which the incident occurred. | Required | 65.0 | ## Response Body for POST [Verify Policy Coverage](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/connect_responses_verify_policy_coverage.htm "Output representation of a policy coverage's applicability for a specified loss date under an insurance policy.") # Verify Policy Coverage Action Verify whether a policy coverage is applicable for a specified loss date under an insurance policy, so that only eligible coverages are processed for claims. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/verifyPolicyCoverage Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | verifyPolicyCoverageInputRep | Apex-defined | Required. An Apex [ConnectApi.VerifyPolicyCoverageInputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_input_verify_policy_coverage_input_re.htm "Invocable action input representation details to verify the coverage of a specific insurance policy.") record that contains the details of a policy coverage whose applicability on a specified loss date under an insurance policy must be verified. | ## Outputs | Output | Type | Description | | --- | --- | --- | | verifyPolicyCoverageOutputRep | Apex-defined | An Apex [ConnectApi.VerifyPolicyCoverageOutputRep](https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/apex_connectapi_output_verify_policy_coverage_output_re.htm "Invocable action output representation for verify policy coverage.") record that contains the details of a policy coverage whose applicability on a specified loss date under an insurance policy is verified. | ## Example Sample Request { "inputs": \[ { "verifyPolicyCoverageInputRep": { "coverageId": "1pcS70000004oVfIAI", "insuredAssetOrParticipantId": "0kaxx000000001dEAA", "lossDate": "2025-08-15", "policyId": "0YTx0000000001qEAA" } } \] } Sample Response \[ { "actionName": "verifyPolicyCoverage", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "verifyPolicyCoverageOutputRep": { "errors": \[\], "isSuccess": true } }, "sortOrder": -1, "version": 1 } \] # Verify Policy Coverage Input Input representation of a policy coverage's applicability for a specified loss date under an insurance policy. ## JSON Example { "lossDate": "2025-09-13", "insuredAssetOrParticipantId": "0kaxx000000001dEAA" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | insuredAsset​Or​ParticipantId | String | ID of the insured asset or participant that's related to the policy coverage. | Required | 65.0 | | lossDate | String | Date on which the incident occurred. | Required | 65.0 |