Insurance Product Rating (POST, PATCH)

Rate products or update product ratings in insurance quoting processes.

Resource

1/connect/insurance/product-rating

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

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

1{
2  "transactionType": "AutoTransactionType",
3  "additionalFields": {
4    "QuoteAccount": "001ZM000002ZNnBYAW"
5  },
6  "ratingOptions": {
7    "executeConfigurationRules": false
8  },
9  "ratingInputs": [
10    {
11      "productCode": "auto",
12      "instanceKeys": [
13        "Auto1"
14      ],
15      "attributes": {
16        "Make": "BMW",
17        "AutoValue": "20000",
18        "Year": "2024",
19        "Model": "SUV"
20      }
21    },
22    {
23      "productCode": "comprehensive",
24      "instanceKeys": [
25        "Auto1",
26        "Comprehensive"
27      ],
28      "attributes": {
29        "Limit": "2000",
30        "Deductible": "100"
31      }
32    }
33  ],
34  "rootProductCodes": [
35    "auto-ECO1x",
36    "auto-ECO2x"
37  ]
38}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFields`	Map<String, Object>	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[]	JSON that contains the attribute values of each context node.	Required	63.0
`ratingOptions`	Rating Options Input[]	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

Request Body for PATCH

JSON Example

1{
2  "contextId": "a49103b233638b918217c74eced69220e534e160c3d3d35bc8cf6608515aeab3",
3  "ratingOptions": {
4    "executePricing": true,
5    "executeConfigurationRules": false
6  },
7  "updatedNodes": [
8    {
9      "instanceKeys": [
10        "AutoSilver",
11        "BMW",
12        "Tim1"
13      ],
14      "productCode": "driver",
15      "attributes": {
16        "DriverAccidentPoints": 1,
17        "AgeFirstLicensed": 50,
18        "DriverMVRPoints": 1
19      },
20      "targetRecords": [
21        "003DR000002ov8NYAQ",
22        "001DR000003avQCYAY"
23      ]
24    }
25  ],
26  "addedNodes": [
27    {
28      "instanceKeys": [
29        "AutoSilver",
30        "Tesla"
31      ],
32      "productCode": "auto",
33      "attributes": {
34        "Year": "2022",
35        "Model": "Y"
36      }
37    },
38    {
39      "instanceKeys": [
40        "AutoSilver",
41        "Tesla",
42        "collision1"
43      ],
44      "productCode": "collision",
45      "attributes": {
46        "Limit": 500,
47        "Deductible": 1000
48      }
49    },
50    {
51      "instanceKeys": [
52        "AutoSilver",
53        "Tesla",
54        "Driver1"
55      ],
56      "productCode": "driver",
57      "attributes": {
58        "DriverAccidentPoints": 5,
59        "AgeFirstLicensed": 30,
60        "DriverMVRPoints": 1
61      },
62      "targetRecords": [
63        "003DR000002oxCfYAI",
64        "001DR000003azdpYAA"
65      ]
66    },
67    {
68      "instanceKeys": [
69        "AutoSilver",
70        "Audi",
71        "Collision2"
72      ],
73      "productCode": "collision",
74      "attributes": {
75        "Limit": 500,
76        "Deductible": 1000
77      }
78    }
79  ]
80}

Properties

Name	Type	Description	Required or Optional	Available Version
`addedNodes`	Rating Input Node[]	List of added nodes.	Optional	63.0
`additionalFields`	Map<String, Object>	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[]	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[]	Options for rating.	Optional	63.0
`updatedNodes`	Rating Input Node[]	List of updated nodes.	Optional	63.0

Response Body for PATCH

Product Rating Response