Endorse Contract Action

Create an endorsed contract version from an existing contract based on the quote for mid-term adjustments.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/endorseContract

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`insuranceContractEndorseInputRepresentation`	Apex-defined	Required. An Apex ConnectApi.InsuranceContractEndorseInputRepresentation record that contains the details to endorse an insurance contract.

Outputs

Output	Type	Description
`insuranceContractEndorseOutputRepresentation`	Apex-defined	An Apex ConnectApi.InsuranceContractEndorseRepresentation record that contains the status of the action, any error messages, and the ID of the endorsed contract.

Example

POST

This sample request is for the Endorse Contract action.

1{
2  "inputs": [
3    {
4      "insuranceContractEndorseInputRepresentation": {
5        "quoteId": "0Q0xx0000004CtoCAE",
6        "effectiveDate": "2026-02-01",
7        "updateExistingContractDates": false,
8        "additionalFields": {
9          "insuranceContractItemList": [
10            {
11              "entity": "Contract",
12              "fields": {
13                "data": [
14                  {
15                    "key": "Description",
16                    "value": "Renewed for FY2026"
17                  }
18                ]
19              }
20            },
21            {
22              "entity": "ContractGroupPlan",
23              "productPath": "dentalBasic",
24              "fields": {
25                "data": [
26                  {
27                    "key": "EnrollmentEndDate",
28                    "value": "2025-12-31"
29                  }
30                ]
31              }
32            }
33          ]
34        }
35      }
36    }
37  ]
38}

This sample response is for the Endorse Contract action.

1[
2  {
3    "actionName": "endorseContract",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "insuranceContractEndorseOutputRepresentation": {
10        "errors": [],
11        "isSuccess": true,
12        "message": "Contract was created from the quote",
13        "contractId": "800xx0000004C92AAE"
14      }
15    },
16    "sortOrder": -1,
17    "version": 1
18  }
19]