Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Brokerage Business APIs
Insurance Brokerage Standard Invocable Actions
Insurance Brokerage Metadata API Types
Insurance Brokerage Apex Reference
ConnectApi Namespace
InsuranceBrokerageFamily Class
InsuranceBrokerageFamily Methods
bulkCancelInsurancePolicy(insurancePolicyBulkInput)
bulkRenewInsurancePolicy(insurancePolicyBulkInput)
createBillingSchedulesFromTransaction(InsuranceTransactionBillingInput)
getCommissionProcessing(commissionProcessingInput)
renewInsurancePolicy(insurancePolicyProcessInput, policyId)
ConnectApi Input Classes
ConnectApi Output Classes
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

bulkCancelInsurancePolicy(insurancePolicyBulkInput)

Cancel policies in bulk for the specified Insurance Policy IDs.

API Version

64.0

Requires Chatter

No

Signature

public static ConnectApi.InsurancePolicyBulkOutputRepresentation bulkCancelInsurancePolicy(ConnectApi.InsurancePolicyBulkInputRepresentation insurancePolicyBulkInput)

1ConnectApi.InsuranceBrokerageFamily, bulkCancelInsurancePolicy, [ConnectApi.InsurancePolicyBulkInputRepresentation], ConnectApi.InsurancePolicyBulkOutputRepresentation

Parameters

insurancePolicyBulkInput
Type: ConnectApi.InsurancePolicyBulkInputRepresentation
Input representation of the request to cancel policies in bulk.

Return Value

Type: ConnectApi.InsurancePolicyBulkOutputRepresentation

Usage

Use this method to cancel insurance policies. The JSON input includes a field value map of insurance policy fields, such as CancellationEffectiveDate, Status, and CancellationReason, and a list of insurance policy IDs. After the request is successfully sent to the message queue, policies are canceled asynchronously, and a success or failure notification is sent to the user after the completion of the request.