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.

1/connect/insurance/contracts/{contractId}/actions/generate-quote

Resource Example 

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

1https://{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 NameTypeDescriptionRequired or OptionalAvailable Version
contractIdStringID of the insurance contract.Required68.0

Request Body for POST 

JSON Example 

1{
2  "quoteName": "QuoteFromContract1",
3  "eventEffectiveFromDate": "2027-03-20",
4  "groupCensusId": "0rfxx000000000BAAQ",
5  "transactionType": "GroupInsuranceTransactionType",
6  "insuranceQuoteType": "GroupEndorsement",
7  "configOptions": {
8    "executeConfigurationRules": false,
9    "executeQualificationRules": false
10  },
11  "additionalFields": {
12    "insuranceQuoteItemList": [
13      {
14        "entity": "Quote",
15        "fields": {
16          "data": [
17            {
18              "key": "StandardAmount",
19              "value": 80
20            }
21          ]
22        }
23      },
24      {
25        "entity": "QuoteLineItem",
26        "productPath": "medBasic",
27        "fields": {
28          "data": [
29            {
30              "key": "UnitPrice",
31              "value": 900
32            }
33          ]
34        }
35      },
36      {
37        "entity": "QuoteLineItem2",
38        "productPath": "medBasic/pcw1",
39        "fields": {
40          "data": [
41            {
42              "key": "PlanAllocationType__std",
43              "value": "STANDARD"
44            }
45          ]
46        }
47      }
48    ]
49  }
50}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
additionalFieldsInsurance Quote Item Input[]List of additional entity field values to apply when creating the quote.Optional68.0
censusRatingTypeStringRating type to use for the census when calculating the quote, such as Summary or Member.Optional68.0
configOptionsInsurance Quote Configuration Options Input Configuration options that control whether configuration and qualification rules run during quote creation.Optional68.0
eventEffectiveFromDateStringDate that the quote is effective from.Required68.0
eventEffectiveToDateStringExpiration date of the quote.Required68.0
groupCensusIdStringID of the group census that the quote is created for.Required68.0
insuranceQuoteTypeStringType of insurance quote to be created from the contract.Required68.0
quoteNameStringName of the quote.Optional68.0
ratingDateStringDate on which the rating of the quote is calculated.Optional68.0
transactionTypeStringType of insurance transaction, such as endorsement or renewal.Required68.0

Response Body for POST 

Insurance Create Quote From Contract Response