Create Contract From Quote Asynchronous Action

Asynchronously create a group insurance contract from a quote.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

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

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input Type Description
insuranceContractCreationInputRepresentation Apex-defined Required. An Apex ConnectApi.InsuranceContractCreationInputRepresentation object that contains the details of the contract to be created.

Outputs

Output Type Description
requestId string ID of the asynchronous request that's created when the contract service is initiated.

Example

Sample Request

{
  "inputs": [
    {
      "insuranceContractCreationInputRepresentation": {
        "quoteId": "0Q0SG000000DQA00AO",
        "contractStartDate": "2025-03-11",
        "contractEndDate": "2026-03-11",
        "enrollmentStartDate": "2025-01-01",
        "enrollmentEndDate": "2025-02-01",
        "contractTerm": 1,
        "additionalFields": [
          {
            "entity": "Contract",
            "fields": {
              "data": [
                {
                  "key": "CustomerSignedTitle",
                  "value": "Mr"
                }
              ]
            }
          },
          {
            "entity": "ContractGroupPlan",
            "instanceKey": "d5861be1-9920-42d9-8f43-093b0a709d35",
            "fields": {
              "data": [
                {
                  "key": "EligibilityCriteria",
                  "value": "testcriteria"
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

Sample Response

[
  {
    "actionName": "createContractFromQuote",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "requestId": "15Uxx0000004XYZABC"
    }
  }
]