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

1/connect/insurance/quotes

Resource Example

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

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/quotes

Available Version

63.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "quoteName": "Auto Insurance Quote",
3  "effectiveDate": "2024-06-30T00:00:00.000Z",
4  "expirationDate": "2025-07-28T00:00:00.000Z",
5  "opportunityId": "006xx000001a2odAAA",
6  "transactionType": "AutoTransactionType",
7  "salesTransactionTypeId": "1Chxx0000004C92CAE",
8  "priceBookId": "01sxx0000005ptpAAA",
9  "configOptions": {
10    "executePricing": false,
11    "validateProductCatalog": false,
12    "executeConfigurationRules": false,
13    "executeQualificationRules": false
14  },
15  "options": {
16    "saveQuote": true,
17    "productSellingModel": "One Time"
18  },
19  "quoteInputs": [
20    {
21      "productCode": "autoRoot",
22      "instanceKeys": [
23        "AutoRoot"
24      ],
25      "items": [
26        {
27          "productCode": "autoBundle",
28          "instanceKeys": [
29            "AutoRoot",
30            "AutoBundle1"
31          ],
32          "attributes": {
33            "avMake": "BMW",
34            "avValue": "20000",
35            "avYear": "2020",
36            "AutoValueFactor": 5,
37            "AutoAgeFactor": 6
38          }
39        },
40        {
41          "productCode": "autoDriver",
42          "instanceKeys": [
43            "AutoRoot",
44            "AutoBundle1",
45            "AutoDriver"
46          ],
47          "relatedRecords": [
48            {
49              "relatedRecordId": "001xx000003GYiEAAW",
50              "relatedRecordObjName": "Account"
51            },
52            {
53              "relatedRecordId": "001xx000003GYiEAAV",
54              "relatedRecordObjName": "Contact"
55            }
56          ]
57        },
58        {
59          "productCode": "autoComp",
60          "instanceKeys": [
61            "AutoRoot",
62            "AutoBundle1",
63            "AutoComp"
64          ],
65          "attributes": {
66            "CompBasePremium": "750"
67          }
68        },
69        {
70          "productCode": "autoBundle",
71          "instanceKeys": [
72            "AutoRoot",
73            "AutoBundle2"
74          ],
75          "attributes": {
76            "avMake": "Audi",
77            "avValue": "20000",
78            "avYear": "2020",
79            "AutoValueFactor": 5,
80            "AutoAgeFactor": 6
81          }
82        },
83        {
84          "productCode": "autoDriver",
85          "instanceKeys": [
86            "AutoRoot",
87            "AutoBundle2",
88            "AutoDriver"
89          ],
90          "relatedRecords": [
91            {
92              "relatedRecordId": "001xx000003GYiEAAW",
93              "relatedRecordObjName": "Account"
94            },
95            {
96              "relatedRecordId": "001xx000003GYiEAAV",
97              "relatedRecordObjName": "Contact"
98            }
99          ]
100        },
101        {
102          "productCode": "autoCollision",
103          "instanceKeys": [
104            "AutoRoot",
105            "AutoBundle2",
106            "AutoCollision1"
107          ],
108          "attributes": {
109            "CollisionBasePremium": "120"
110          }
111        }
112      ]
113    }
114  ]
115}

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<String, Object>	Additional fields that are used to create insurance quote.	Optional	63.0
`configOptions`	Insurance Quote Config Options []	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[]	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[]	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