Create a renewed insurance contract from a renewal quote, carrying forward the
applicable contract details and line items for the next coverage term.
Resource
/connect/insurance/contracts/actions/renew
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/renew
Available Version
68.0
HTTP Methods
POST
Request Body for POST
JSON Example
{
"quoteId": "0Q0xx0000004CtoCAE",
"renewalDate": "2026-03-11",
"contractEndDate": "2027-03-11",
"contractTerm": 12,
"targetContractId": "800xx0000004C92AAE",
"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 apply to contract objects when the renewed contract is created. | Optional | 68.0 |
| contractEndDate | String | End date of the renewed contract. Specify the date in the yyyy-MM-dd format. | Required | 68.0 |
| contractTerm | Integer | Duration of the renewed contract in months. The default value is 12. | Optional | 68.0 |
| quoteId | String | ID of the quote from which you want to create the renewed contract. | Required | 68.0 |
| renewalDate | String | Date that the renewed contract term starts. Specify the date in the yyyy-MM-dd format. | Required | 68.0 |
| targetContractId | String | ID of the existing contract that the renewal is based on, when you need to identify the prior contract explicitly. | Optional | 68.0 |