Add Eligible Insurance Clauses Action

Add eligible insurance clauses to a quote or context. You must specify either a quote ID or a context ID, and either an instance key or a quote line item ID along with insurance product clause details.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/v65.0/actions/standard/addEligibleInsuranceClauses
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.
insuranceProductClauses	Type string Description Required. JSON object with the details of the insurance product clauses to add.
optionFlags	Type Apex-defined Description Options to add eligible clauses.
quoteId	Type string Description Required if contextId isn't specified. ID of the insurance quote to add eligible clauses.
quoteLineItemId	Type string Description Required if instanceKey isn't specified. ID of the quote line items for adding eligible clauses.

Outputs

Output	Details
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`).
quoteLineItemInsProductClauseIds	Type string Description IDs of the quote line item insurance product clauses.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "quoteId": "0Q0xx0000000001AAA",
5      "quoteLineItemId": "0QLxx0000000002BBB",
6      "contextId": "0j5xx0000000003CCC",
7      "instanceKey": [
8        "Auto",
9        "Liability"
10      ],
11      "insuranceProductClauses": [
12        {
13          "insuranceProductClauseId": "0j4xx0000000004DDD",
14          "effectiveDate": "2025-01-01",
15          "expirationDate": "2025-12-31"
16        }
17      ],
18      "optionFlags": {
19        "saveContext": true
20      }
21    }
22  ]
23}

Sample Response

1[
2  {
3    "actionName": "addEligibleInsuranceClauses",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isSuccess": true,
10      "quoteLineItemInsProductClauseIds": [
11        "a1Cxx0000000001AAA"
12      ],
13      "errorsList": []
14    },
15    "sortOrder": -1,
16    "version": 1
17  }
18]

Insurance Developer Guide

Add Eligible Insurance Clauses Action

Supported REST HTTP Methods

Inputs

Outputs

Example