Create an endorsed contract version from a quote for mid-term adjustments. This API
shortens the existing contract, creates a new version of the contract and contract group plan
records along with their associated attributes based on the finalized endorsement quote, and
links both versions.
Resource
/connect/insurance/contracts/actions/endorse
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/actions/endorse
Available Version
68.0
HTTP Methods
POST
Request Body for POST
JSON Example
{
"quoteId": "0Q0xx0000004CtoCAE",
"effectiveDate": "2026-02-01",
"updateExistingContractDates": false,
"additionalFields": {
"insuranceContractItemList": [
{
"entity": "Contract",
"fields": {
"data": [
{
"key": "Description",
"value": "Renewed for FY2026"
}
]
}
},
{
"entity": "InsuranceContract",
"fields": {
"data": [
{
"key": "myCustomPickList__c",
"value": "Alive"
},
{
"key": "EnrollmentEndDate",
"value": "2022-01-20"
},
{
"key": "EnrollmentStartDate",
"value": "2021-01-20"
}
]
}
},
{
"entity": "ContractGroupPlan",
"productPath": "dentalBasic",
"fields": {
"data": [
{
"key": "EnrollmentEndDate",
"value": "2025-12-31"
}
]
}
}
]
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalFields | Insurance Contract Item Input[] | List of additional fields to add to contract items. | Optional | 68.0 |
| effectiveDate | String | Effective date of endorsement that indicates the start date of the endorsed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 |
| quoteId | String | ID of the quote for contract endorsement. | Required | 68.0 |
| updateExistingContractDates | Boolean | Indicates whether to update dates on the existing contract when creating the endorsed contract version ( true) or not ( false). | Optional | 68.0 |