Insurance Underwriting Rules (PATCH)

Update an existing underwriting rule for a root product.

Resource 

{underwritingRuleId} is a placeholder.

1/connect/insurance/underwriting-rules/{underwritingRuleId}

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org. {underwritingRuleId} is a placeholder.

1https://{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 

1{
2       "name": "Automatically Approve Quote",
3       "apiName": "approveQuoteBasedonComprehensiveCoverageDeductibles",
4       "effectiveFromDate": "2024-05-30T10:30:00",
5       "effectiveToDate": "2024-11-01T10:30:00",
6       "productPath": "01tDR000000EMslYAG/11BDR00000000T72AI", // "Auto Gold/Auto Vehicle"
7       "ruleCriteria": [ // ruleCrieteria will be replaced as a whole. Updating only one condition is not supported
8       {
9       "conditions": [
10       {
11       "contextTagName": "SalesTransactionItemAttribute",
12       "operator": "LessThan",
13       "conditionIndex": 1,
14       "attributeName": "Annual Milage",
15       "attributePicklistValueId": null,
16       "type": "Attribute",
17       "attributeId": "0tjDR00000000VGYAY",
18       "dataType": "Number",
19       "values": [
20       "50000"
21       ]
22       }
23       ],
24       "rootObjectId": "01tDR000000EMslYAG", // Auto Gold.
25       "productRelatedComponent" : // Need More details on it.
26       "criteriaIndex": 1,
27       "sourceContextTagName": "ProductBasedOn",
28       "sourceOperator": "Equals",
29       "sourceDataType": "String",
30       "sourceValues": [
31       "11BDR00000000T72AI" // Auto Vehicle.
32       ]
33       },
34       {
35       "conditions": [
36       {
37       "contextTagName": "SalesTransactionItemAttribute",
38       "operator": "LessThan",
39       "conditionIndex": 1,
40       "attributeName": "Comprehensive Deductible",
41       "type": "Attribute",
42       "attributePicklistValueId": null,
43       "attributeId": "0tjDR00000000UaYAI",
44       "dataType": "Number",
45       "values": [
46       "$5000"
47       ]
48       }
49       ],
50       "rootObjectId": "01tDR000000EMslYAG", // Auto Bundle
51       "productRelatedComponent" : // Need More details on it.
52       "criteriaIndex": 2,
53       "sourceContextTagName": "Product",
54       "sourceOperator": "Equals",
55       "sourceDataType": "String",
56       "sourceValues": [
57       "01tDR000000EMsoYAG" // Comprehensive Product.
58       ]
59       }
60       ],
61       // EvaluationSuccessTaskGroup and EvaluationFailureTaskGroup are opitional
62       // Fulfillment plan design time entities will be created.
63       "EvaluationSuccessTaskGroup": // Create FulfillmentStepDefinitionGroup records
64       {
65       "name": "QuoteApproveSuccessTaskGroup",
66       "taks": [ // create FulfillmentStepDefinition records
67       {
68       "name": "KYC check flow", // FulfillmentStepDefinition API Names
69       "type": "AutoTask",// FulfillmentStepDefinition type
70       "flowApiName": "KYC check flow", // Flow API Names
71       }
72       ]
73       },
74       "EvaluationFailureTaskGroup": //Similar to EvaluationSuccessTaskGroup
75       {
76       "name": "QuoteApproveFailureTaskGroup",
77       "taks": [
78       {
79       "name": "Vehicle ineligible",
80       "type": "AutoTask",
81       "flowApiName": "Mail Notification - Vehicle ineligible",
82       }
83       ]
84       }
85       }

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
descriptionStringDescription of the underwriting rule.Optional63.0
effectiveFromDateStringDate from which the underwriting rule is effective.Optional63.0
effectiveToDateStringDate until which the underwriting rule is effective.Optional63.0
evaluationFailureTaskGroupEvaluation Task Group Input[]Input details for failed evaluation tasks.Optional63.0
evaluationSuccessTaskGroupEvaluation Task Group Input[]Input details for successful evaluation tasks.Optional63.0
nameStringName of the underwriting rule.Optional63.0
productPathStringName of the product path.Optional63.0
ruleCriteriaInsurance Rule Criteria Input[]Rule criteria for the underwriting rule.Required63.0
statusStringStatus of the underwriting rule. Possible values are:
  • Active
  • Inactive
  • Draft
Optional63.0

Response Body for PATCH 

Insurance Update Underwriting Rules