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

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

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  "targetContractId": "800xx0000004C92AAE",
7  "additionalFields": {
8    "insuranceContractItemList": [
9      {
10        "entity": "Contract",
11        "fields": {
12          "data": [
13            {
14              "key": "Description",
15              "value": "Renewed for FY2026"
16            }
17          ]
18        }
19      },
20      {
21        "entity": "InsuranceContract",
22        "fields": {
23          "data": [
24            {
25              "key": "myCustomPickList__c",
26              "value": "Alive"
27            },
28            {
29              "key": "EnrollmentEndDate",
30              "value": "2022-01-20"
31            },
32            {
33              "key": "EnrollmentStartDate",
34              "value": "2021-01-20"
35            }
36          ]
37        }
38      },
39      {
40        "entity": "ContractGroupPlan",
41        "productPath": "dentalBasic",
42        "fields": {
43          "data": [
44            {
45              "key": "EnrollmentEndDate",
46              "value": "2025-12-31"
47            }
48          ]
49        }
50      }
51    ]
52  }
53}

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

Response Body for POST

Contract Renewal Response