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<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