---
schema_version: "1"
id: 7b2ae45b0eb5ba684c9670fa7e1575d6ff6149e09b404a42b88abdc416d289ff
title: Get Eligible Insurance Clauses Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/insurance_developer_guide/actions_obj_get_eligible_insurance_clauses.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.insurance_developer_guide.meta/insurance_developer_guide/actions_obj_get_eligible_insurance_clauses.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: bc9b2c2142e64f2b53a7e09edfaf72714154e5b013e0b0c0f13e49cecc64f6e7
description: 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.
---
# 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/vXX.X/actions/standard/getEligibleInsuranceClauses

Where XX.X is the latest API version.

**Formats**: JSON, XML

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

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

## Outputs

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

## Example

Sample Request

{
  "inputs": \[
    {
      "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59",
      "instanceKey": \[
        "a3Nxx000000CmikEAC"
      \],
      "quoteId": "0Q0xx000000Dm3jCAC",
      "quoteLineItemId": "0QLxx000000E5d1OAC"
    }
  \]
}

This is a sample request to call this invocable action from Apex code.

// Sample Apex call for getEligibleInsuranceClauses invocable action
public class GetEligibleInsuranceClausesInvoke {
    private static final String ACTION\_NAME = 'getEligibleInsuranceClauses';

    public static Boolean invokeMethod(Map<String, Object> inputs, Map<String, Object> output) {
        if (output == null) {
            output = new Map<String, Object>();
        }

        try {
            Invocable.Action action = Invocable.Action.createStandardAction(ACTION\_NAME);

            // Either quoteId or contextId is required
            setInvocationParameter(action, inputs, 'quoteId', false);
            setInvocationParameter(action, inputs, 'contextId', false);

            // Either quoteLineItemId or instanceKey is required
            setInvocationParameter(action, inputs, 'quoteLineItemId', false);
            setInvocationParameter(action, inputs, 'instanceKey', false);

            List<Invocable.Action.Result> results = action.invoke();
            if (results != null && !results.isEmpty() && results\[0\].isSuccess()) {
                output.put('output', results\[0\].getOutputParameters());
                output.put('success', true);
                return true;
            }

            output.put('success', false);
            if (results != null && !results.isEmpty()) {
                output.put('errors', results\[0\].getErrors());
            }
            return false;
        } catch (Exception e) {
            output.put('success', false);
            output.put('errorMessage', e.getMessage());
            return false;
        }
    }

    private static void setInvocationParameter(
        Invocable.Action action,
        Map<String, Object> payload,
        String attribute,
        Boolean serializeJson
    ) {
        if (payload != null && payload.containsKey(attribute) && payload.get(attribute) != null) {
            if (serializeJson) {
                action.setInvocationParameter(attribute, JSON.serialize(payload.get(attribute)));
            } else {
                action.setInvocationParameter(attribute, payload.get(attribute));
            }
        }
    }
}

Sample Response

\[
  {
    "actionName": "getEligibleInsuranceClauses",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "getEligibleClausesOutputRep": {
        "errors": \[\],
        "insuranceProductClauses": \[
          {
            "category": "Manual",
            "clauseName": "mxtestIC",
            "description": "two variable",
            "effectiveDate": "2025-10-01",
            "expirationDate": "2025-12-31",
            "insuranceProductClauseId": "...",
            "type": "Clause"
          }
        \],
        "success": true
      }
    },
    "sortOrder": -1,
    "version": 1
  }
\]