Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Endorse Insurance Brokerage Policy Action

Complete an in-progress endorsement of an insurance brokerage policy.

This action is available in API version 67.0 and later.

Special Access Rules

The Endorse Insurance Brokerage Policy action is available in Enterprise, Unlimited, and Developer Editions where Financial Service Cloud and Insurance Brokerage are enabled. To use this action, you need the Insurance Brokerage User permission set.

Supported REST HTTP Methods

URI
/services/data/v68.0/actions/standard/endorseInsBrokeragePolicy
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
inputRep
Type
Apex-defined
Description
Required. An Apex ConnectApi__EndorseBrokeragePolicyIAInputRep record that contains the ID of the insurance brokerage policy to endorse.

Outputs

Output Details
transactionId
Type
string
Description
Transaction ID that's generated during the policy endorsement process.

Example

POST

This sample request is for the Endorse Insurance Brokerage Policy action.

1{
2  "inputs": [
3    {
4      "inputRep": {
5        "policyId": "0YjXX0000000001"
6      }
7    }
8  ]
9}

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

1// Create the standard Invocable Action for endorsing a brokerage policy
2Invocable.Action action = Invocable.Action.createStandardAction('endorseInsBrokeragePolicy');
3
4// Instantiate the input object
5ConnectApi.EndorseBrokeragePolicyIAInputRep input = new ConnectApi.EndorseBrokeragePolicyIAInputRep();
6
7// Required: Set the Policy ID of the brokerage policy to be endorsed
8input.policyId = '0YjXX0000000001';
9
10// Set the invocation parameter and invoke
11action.setInvocationParameter('endorseBrokeragePolicyIAInputRep', input);
12List<Invocable.Action.Result> results = action.invoke();
13
14System.debug('Endorse Brokerage Policy Invocable Action result = ' + results);

This is the sample response for the Endorse Insurance Brokerage Policy action.

1[
2  {
3    "actionName": "endorseInsBrokeragePolicy",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "transactionId": "txn_abc123def456"
10    },
11    "sortOrder": -1,
12    "version": 1
13  }
14]