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.

Cancel Insurance Brokerage Policy Action

Cancel an insurance brokerage policy with optional cancellation details such as effective date, reason, and target status.

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/v68.0/actions/standard/cancelInsBrokeragePolicy
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
inputRep	Type Apex-defined Description Required. An Apex ConnectApi__CancelBrokeragePolicyIAInputRep record that contains the details to cancel an insurance policy.

Outputs

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

Example

POST

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

1{
2  "inputs": [
3    {
4      "inputRep": {
5        "policyId": "0YjXX0000000001",
6        "cancellationEffectiveDate": "2026-07-01",
7        "cancellationReason": "Customer requested cancellation",
8        "status": "Cancelled"
9      }
10    }
11  ]
12}

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

1// Create the standard Invocable Action for canceling a brokerage policy
2Invocable.Action action = Invocable.Action.createStandardAction('cancelInsBrokeragePolicy');
3
4// Instantiate the input object
5ConnectApi.CancelBrokeragePolicyIAInputRep input = new ConnectApi.CancelBrokeragePolicyIAInputRep();
6
7// Required: Set the Policy ID of the brokerage policy to be canceled
8input.policyId = '0YjXX0000000001';
9
10// Optional: Set cancellation details
11input.cancellationEffectiveDate = '2026-07-01';
12input.cancellationReason = 'Customer requested cancellation';
13input.status = 'Cancelled';
14
15// Set the invocation parameter and invoke
16action.setInvocationParameter('cancelBrokeragePolicyIAInputRep', input);
17List<Invocable.Action.Result> results = action.invoke();
18
19System.debug('Cancel Brokerage Policy Invocable Action result = ' + results);

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

1[
2  {
3    "actionName": "cancelInsBrokeragePolicy",
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]

Insurance Developer Guide