Get Eligible Insurance Clauses Action

Get eligible insurance clauses based on quote ID and context ID. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID to get the eligible insurance clauses.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

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

Inputs

Input	Details
contextId	Type string Description Required if quoteId isn't specified. Context ID of the insurance quote.
instanceKey	Type string Description Required if quoteLineItemId isn't specified. Unique key that identifies the product to which a quote line item belongs.
quoteId	Type string Description Required if contextId isn't specified. ID of the insurance quote to get eligible clauses.
quoteLineItemId	Type string Description Required if instanceKey isn't specified. ID of the quote line items to get eligible clauses.

Outputs

Output	Details
eligibleClauses	Type string Description Details of insurance product clauses.
errorsList	Type string Description Errors that are encountered during the operation.
isSuccess	Type boolean Description Indicates whether the operation is successful (`true`) or not (`false`).

Example

Sample Request

1{
2  "inputs": [
3    {
4      "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59",
5      "instanceKey": [
6        "a3Nxx000000CmikEAC"
7      ],
8      "quoteId": "0Q0xx000000Dm3jCAC",
9      "quoteLineItemId": "0QLxx000000E5d1OAC"
10    }
11  ]
12}

Sample Response

1[
2  {
3    "actionName": "getEligibleInsuranceClauses",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isSuccess": true,
10      "eligibleClauses": [
11        {
12          "category": "Manual",
13          "clauseName": "Manual Clause 1",
14          "description": "This is a manually added clause.",
15          "effectiveDate": "2025-10-01T12:00:00.000Z",
16          "expirationDate": "2026-10-01T12:00:00.000Z",
17          "insuranceProductClauseId": "a4Lxx000000Cde1EAC",
18          "type": "Clause"
19        }
20      ],
21      "errorsList": []
22    },
23    "sortOrder": -1,
24    "version": 1
25  }
26]

Insurance Developer Guide

Get Eligible Insurance Clauses Action

Supported REST HTTP Methods

Inputs

Outputs

Example