Endorse Contract Action | Insurance Developer Guide

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/endorseContract
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearertoken

Inputs

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

Outputs

Output	Details
insuranceContractEndorseOutputRepresentation	Type Apex-defined Description 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        "enrollmentStartDate": "2026-03-01",
8        "enrollmentEndDate": "2026-12-31",
9        "updateExistingContractDates": false,
10        "additionalFields": {
11          "insuranceContractItemList": [
12            {
13              "entity": "Contract",
14              "fields": {
15                "data": [
16                  {
17                    "key": "Description",
18                    "value": "Renewed for FY2026"
19                  }
20                ]
21              }
22            },
23            {
24              "entity": "ContractGroupPlan",
25              "productPath": "dentalBasic",
26              "fields": {
27                "data": [
28                  {
29                    "key": "EnrollmentEndDate",
30                    "value": "2025-12-31"
31                  }
32                ]
33              }
34            }
35          ]
36        }
37      }
38    }
39  ]
40}

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]