Endorse Contract (POST)

Create an endorsed contract version from a quote for mid-term adjustments. This API shortens the existing contract, creates a new version of the contract and contract group plan records along with their associated attributes based on the finalized endorsement quote, and links both versions.

Resource

1/connect/insurance/contracts/actions/endorse

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/endorse

Available Version

68.0

HTTP Methods

POST

Request Body for POST

JSON Example

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

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
`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