Endorse Contract Action

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: Bearer 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.

{
  "inputs": [
    {
      "insuranceContractEndorseInputRepresentation": {
        "quoteId": "0Q0xx0000004CtoCAE",
        "effectiveDate": "2026-02-01",
        "updateExistingContractDates": false,
        "additionalFields": {
          "insuranceContractItemList": [
            {
              "entity": "Contract",
              "fields": {
                "data": [
                  {
                    "key": "Description",
                    "value": "Renewed for FY2026"
                  }
                ]
              }
            },
            {
              "entity": "ContractGroupPlan",
              "productPath": "dentalBasic",
              "fields": {
                "data": [
                  {
                    "key": "EnrollmentEndDate",
                    "value": "2025-12-31"
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

This sample response is for the Endorse Contract action.

[
  {
    "actionName": "endorseContract",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "insuranceContractEndorseOutputRepresentation": {
        "errors": [],
        "isSuccess": true,
        "message": "Contract was created from the quote",
        "contractId": "800xx0000004C92AAE"
      }
    },
    "sortOrder": -1,
    "version": 1
  }
]