Renew Contract (POST)

Create a renewed insurance contract from a renewal quote, carrying forward the applicable contract details and line items for the next coverage term.

Resource

1/connect/insurance/contracts/actions/renew

Resource example

1https://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

1{
2  "quoteId": "0Q0xx0000004CtoCAE",
3  "renewalDate": "2026-03-11",
4  "contractEndDate": "2027-03-11",
5  "contractTerm": 12,
6  "enrollmentStartDate": "2026-03-11",
7  "enrollmentEndDate": "2026-04-11",
8  "targetContractId": "800xx0000004C92AAE",
9  "additionalFields": {
10    "insuranceContractItemList": [
11      {
12        "entity": "Contract",
13        "fields": {
14          "data": [
15            {
16              "key": "Description",
17              "value": "Renewed for FY2026"
18            }
19          ]
20        }
21      },
22      {
23        "entity": "InsuranceContract",
24        "fields": {
25          "data": [
26            {
27              "key": "myCustomPickList__c",
28              "value": "Alive"
29            },
30            {
31              "key": "EnrollmentEndDate",
32              "value": "2022-01-20"
33            },
34            {
35              "key": "EnrollmentStartDate",
36              "value": "2021-01-20"
37            }
38          ]
39        }
40      },
41      {
42        "entity": "ContractGroupPlan",
43        "productPath": "dentalBasic",
44        "fields": {
45          "data": [
46            {
47              "key": "EnrollmentEndDate",
48              "value": "2025-12-31"
49            }
50          ]
51        }
52      }
53    ]
54  }
55}

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
`enrollmentEndDate`	String	End date for plan enrollment on the renewed contract. Specify the date in the yyyy-MM-dd format.	Optional	68.0
`enrollmentStartDate`	String	Start date for plan enrollment on the renewed contract. Specify the date in the yyyy-MM-dd format.	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

Response body for POST

Contract Renewal Response

Insurance Developer Guide

Renew Contract (POST)