Renew Insurance Brokerage Policy Action

This action is available in API version 67.0 and later.

Special Access Rules

The Renew 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/renewInsBrokeragePolicy

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__RenewBrokeragePolicyIAInputRep record that contains the ID and other details of the original brokerage policy to renew.

Outputs

Output	Type	Description
renewedPolicyId	string	ID of the newly created renewed policy.

Example

POST

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

{
  "inputs": [
    {
      "inputRep": {
        "policyId": "0YjXX0000000001",
        "effectiveFromDate": "2027-01-01",
        "effectiveToDate": "2028-01-01",
        "policyName": "Renewed Policy 2027",
        "policyNumber": "POL-2027-RENEW"
      }
    }
  ]
}

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

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

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

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

// Optional: Set renewal details
input.effectiveFromDate = '2027-01-01';
input.effectiveToDate = '2028-01-01';
input.policyName = 'Renewed Policy 2027';
input.policyNumber = 'POL-2027-RENEW';

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

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

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

[
  {
    "actionName": "renewInsBrokeragePolicy",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "renewedPolicyId": "0YjXX0000000100"
    },
    "sortOrder": -1,
    "version": 1
  }
]