Newer Version Available

This content describes an older version of this product. View Latest

Generate Insurance Clauses Action

Generate insurance clauses based on the specified quote and context information. You must specify either quote ID or context ID to generate insurance clauses.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/v65.0/actions/standard/generateInsuranceClauses
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.
instanceKeys
Type

string

Description
Required if quoteLineItemId isn't specified.
Unique keys that identify the products to which quote line items belong.
optionFlags
Type

Apex-defined

Description
Options for clause generation.
quoteId
Type

string

Description
Required if contextId isn't specified.
ID of the insurance quote for adding eligible clauses.
quoteLineItemIds
Type

string

Description
Required if quoteLineItemId isn't specified.
IDs of the quote line item for the quote.

Outputs

Output Details
asyncBulkRequestId
Type

string

Description
ID of the asynchronous bulk request.
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      "quoteId": "0Q0xx0000000001AAA",
5      "contextId": "0000000i18tq18g0025175944829641764efd423f7dc44b98dd1e829086efc59",
6      "quoteLineItemIds": [
7        "0QLxx0000000003CCC"
8      ],
9      "instanceKeys": [
10        {
11          "instanceKey": [
12            "Auto",
13            "Liability"
14          ]
15        }
16      ],
17      "optionFlags": {
18        "generateClausesAsync": true,
19        "generateManualClauses": false,
20        "saveContext": true
21      }
22    }
23  ]
24}

Sample Response

1[
2  {
3    "actionName": "generateInsuranceClauses",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isSuccess": true,
10      "asyncBulkRequestId": "750xx0000000001AAA",
11      "errorsList": []
12    },
13    "sortOrder": -1,
14    "version": 1
15  }
16]