Create Contract From Quote Synchronous Action

Issue a group insurance contract from a quote, creating both the contract and insurance contract records with the full contract group plan hierarchy, including their plan attributes and group class attributes.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

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

Inputs

Input Details
insuranceIssueContractInputRepresentation
Type

Apex-defined

Description
Required. An Apex ConnectApi.InsuranceIssueContractInputRepresentation record that contains the quote details to issue a contract.

Outputs

Output Details
insuranceIssueContractOutputRepresentation
Type

Apex-defined

Description
An Apex ConnectApi.InsuranceIssueContractRepresentation record that contains the result of the contract issue operation, including the contract and insurance contract IDs.

Example

POST

This sample request is for the Issue Contract From Quote Synchronous action.

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

This sample response is for the Issue Contract From Quote Synchronous action.

1[
2  {
3    "actionName": "issueContract",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "insuranceIssueContractOutputRepresentation": {
10        "contractId": "800xx000000br2bAAA",
11        "errors": [],
12        "isSuccess": true,
13        "message": "Contract issued successfully from quote."
14      }
15    },
16    "sortOrder": -1,
17    "version": 1
18  }
19]