Issue Insurance Brokerage Policy Action

This action is available in API version 67.0 and later.

Special Access Rules

The Issue 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/vXX.X/actions/standard/issueInsBrokeragePolicy

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
inputRep	Apex-defined	Required. An Apex ConnectApi__IssueBrokeragePolicyIAInputRep record that contains the ID of the insurance brokerage policy to issue.

Outputs

Output	Type	Description
transactionId	string	Transaction ID that's generated during the policy issuance operation.

Example

POST

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

{
  "inputs": [
    {
      "inputRep": {
        "policyId": "0YjXX0000000001"
      }
    }
  ]
}

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

// Create the standard Invocable Action for issuing a brokerage policy
Invocable.Action action = Invocable.Action.createStandardAction('issueInsBrokeragePolicy');

// Instantiate the input object
ConnectApi.IssueBrokeragePolicyIAInputRep input = new ConnectApi.IssueBrokeragePolicyIAInputRep();

// Required: Set the Policy ID of the brokerage policy to be issued
input.policyId = '0YjXX0000000001';

// Set the invocation parameter and invoke
action.setInvocationParameter('issueBrokeragePolicyIAInputRep', input);
List<Invocable.Action.Result> results = action.invoke();

System.debug('Issue Brokerage Policy Invocable Action result = ' + results);

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

[
  {
    "actionName": "issueInsBrokeragePolicy",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "transactionId": "txn_abc123def456"
    },
    "sortOrder": -1,
    "version": 1
  }
]