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.

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

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