Endorse Contract (POST)

Create an endorsed contract version from a quote for mid-term adjustments. This API carries forward the existing contract and contract group plan details, and links the new version to the previous contract. It also creates contract and contract group plan records along with their associated attributes.

Resource

1/connect/insurance/contracts/actions/endorse

Resource example

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

1{
2  "quoteId": "0Q0xx0000004CtoCAE",
3  "effectiveDate": "2026-02-01",
4  "enrollmentStartDate": "2026-03-01",
5  "enrollmentEndDate": "2026-12-31",
6  "updateExistingContractDates": false,
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 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
`enrollmentEndDate`	String	End date for plan enrollment in the endorsed contract. Specify the date in the yyyy-MM-dd format.	Optional	68.0
`enrollmentStartDate`	String	Start date for plan enrollment in the endorsed contract. Specify the date in the yyyy-MM-dd format.	Optional	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

Response body for POST

Contract Endorsement Response

Insurance Developer Guide

Endorse Contract (POST)