Cancel Insurance Brokerage Policy Action

This action is available in API version 67.0 and later.

Special Access Rules

The Cancel 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/cancelInsBrokeragePolicy

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__CancelBrokeragePolicyIAInputRep record that contains the details to cancel an insurance policy.

Outputs

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

Example

POST

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

{
  "inputs": [
    {
      "inputRep": {
        "policyId": "0YjXX0000000001",
        "cancellationEffectiveDate": "2026-07-01",
        "cancellationReason": "Customer requested cancellation",
        "status": "Cancelled"
      }
    }
  ]
}

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

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

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

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

// Optional: Set cancellation details
input.cancellationEffectiveDate = '2026-07-01';
input.cancellationReason = 'Customer requested cancellation';
input.status = 'Cancelled';

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

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

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

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