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.

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

Resource Example

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

https://{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 Name Type Description Required or Optional Available Version
contractId String ID of the insurance contract. Required 68.0

Request Body for POST

JSON Example

{
  "quoteName": "QuoteFromContract1",
  "eventEffectiveFromDate": "2027-03-20",
  "groupCensusId": "0rfxx000000000BAAQ",
  "transactionType": "GroupInsuranceTransactionType",
  "insuranceQuoteType": "GroupEndorsement",
  "configOptions": {
    "executeConfigurationRules": false,
    "executeQualificationRules": false
  },
  "additionalFields": {
    "insuranceQuoteItemList": [
      {
        "entity": "Quote",
        "fields": {
          "data": [
            {
              "key": "StandardAmount",
              "value": 80
            }
          ]
        }
      },
      {
        "entity": "QuoteLineItem",
        "productPath": "medBasic",
        "fields": {
          "data": [
            {
              "key": "UnitPrice",
              "value": 900
            }
          ]
        }
      },
      {
        "entity": "QuoteLineItem2",
        "productPath": "medBasic/pcw1",
        "fields": {
          "data": [
            {
              "key": "PlanAllocationType__std",
              "value": "STANDARD"
            }
          ]
        }
      }
    ]
  }
}

Properties

Name Type Description Required or Optional Available Version
additionalFields Insurance Quote Item Input[] List of additional entity field values to apply when creating the quote. Optional 68.0
censusRatingType String Rating type to use for the census when calculating the quote, such as Summary or Member. Optional 68.0
configOptions Insurance Quote Configuration Options Input Configuration options that control whether configuration and qualification rules run during quote creation. Optional 68.0
eventEffectiveFromDate String Date that the quote is effective from. Required 68.0
eventEffectiveToDate String Expiration date of the quote. Required 68.0
groupCensusId String ID of the group census that the quote is created for. Required 68.0
insuranceQuoteType String Type of insurance quote to be created from the contract. Required 68.0
quoteName String Name of the quote. Optional 68.0
ratingDate String Date on which the rating of the quote is calculated. Optional 68.0
transactionType String Type of insurance transaction, such as endorsement or renewal. Required 68.0

Response Body for POST