Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Requests
Insurance Person Accounts and Users Creation Input
Portal User Creation Input
Insurance Member Rating Input
Insurance Member Rating Details Input
Insurance Member Rating Plans Input
Insurance Contacts and Users Creation Input
Bulk Group Census Management Input
Insurance Group Census Member Management Input
Group Census Member Input
Additional Fields Map Value
Insurance Update Member Plans Input
Insurance Add Member Plans Input
Group Census Member Plan Input
Group Census Deep Clone Input
Group Census Field Mapping Input
Group Census Filters Input
Group Census Reference Mappings Input
Member Plan Filter Input
Member Plan Reference Mapping Input
Members With Plans Input
Member With Plans Input
Member Plan Input
Attribute Input
Member Overrides Input
Member Override Input
Override Attribute Input
Insurance Group Endorsement Input
Insurance Group Adjustment Input
Insurance Group Renewal Input
Insurance Price Comparison Input
Delete Member Plans Input
Insurance Plans Eligibility Create Context Input
Insurance Plans Eligibility Update Context Input
Insurance Group Plan Input
Contract Creation Input
Contract Item
Apex String
Insurance Create Quote From Contract Input
Insurance Generate Census Input
Update Group Census Input
Insurance Generate Refresh Census Members Input
Insurance Generate Refresh Census Members Additional Fields Input
Insurance Upsert Member Input
Insurance Census Filter Input
Insurance Quote Configuration Options Input
Insurance Quote Item Input
Insurance Issue Contract Input
Insurance Contract Item Input
Insurance Contract Endorse Input
Insurance Contract Renewal Input
Insurance Contract Transactions Generation Input
Group Rating Input
Individual Enrollment Input
Group Enrollment Input
Insurance Delete Census Member Input
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Insurance Contract Renewal Input

Input representation of the details, such as the quote ID, renewal and contract end dates, and optional enrollment window, term, target contract, and additional fields to create a renewed-term contract from a quote.
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