bulkCancelInsurancePolicy(insurancePolicyBulkInput)

Cancel policies in bulk for the specified Insurance Policy IDs.

API Version

64.0

Requires Chatter

Signature

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

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 in bulk. 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 you receive either a success or failure notification after the completion of the request.

Example

The Apex example shows how to use the ConnectApi.InsuranceBrokerageFamily.bulkCancelInsurancePolicy() method to cancel multiple insurance policies in bulk.

Class Definition

This Apex example shows how to cancel multiple policies in bulk.

1global class BulkCancelConnectDriver {
2
3    global static void callBulkCancelConnectAPI() {
4        Map<String, Object> input = new Map<String, Object>();
5
6        ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput = new ConnectApi.InsurancePolicyBulkInputRepresentation();
7
8        List<String> policyIds = new List<String>{
9            '0YTxx000000001dGAA',
10            '0YTxx000000002dGAA',
11            '0YTxx000000003dGAA'
12        };
13        bulkInput.insurancePolicyIds = policyIds;
14
15        Map<String, Object> fields = new Map<String, Object>();
16        fields.put('CancellationReason', 'Batch Cancellation');
17        fields.put('CancellationEffectiveDate', '2026-07-01');
18        bulkInput.fieldValueMap = fields;
19
20        input.put('bulkInput', bulkInput);
21
22        Map<String, Object> output = new Map<String, Object>();
23        Map<String, Object> args = new Map<String, Object>();
24        args.put('input', input);
25        args.put('output', output);
26
27        BulkCancelTestConnectAPI callable = new BulkCancelTestConnectAPI();
28        Object result = callable.call('bulkCancel', args);
29
30        ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData =
31            (ConnectApi.InsurancePolicyBulkOutputRepresentation) result;
32        System.debug('Bulk Cancel Data: ' + JSON.serializePretty(bulkData));
33
34        if (output.containsKey('error')) {
35            System.debug('Error: ' + output.get('error'));
36        }
37    }
38}

Usage Example

Use the BulkCancelTestConnectAPI class to execute the bulkCancel action and process the result.

1public class BulkCancelTestConnectAPI implements System.Callable {
2
3    public Object call(String action, Map<String, Object> args) {
4        Map<String, Object> inputMap = (Map<String, Object>) args.get('input');
5        Map<String, Object> outputMap = (Map<String, Object>) args.get('output');
6
7        if (action == 'bulkCancel') {
8            ConnectApi.InsurancePolicyBulkInputRepresentation bulkInput =
9                (ConnectApi.InsurancePolicyBulkInputRepresentation) inputMap.get('bulkInput');
10            System.debug('Start of Connect API call to bulk cancel policies');
11
12            ConnectApi.InsurancePolicyBulkOutputRepresentation bulkData;
13            try {
14                bulkData = ConnectApi.InsuranceBrokerageFamily.bulkCancelInsurancePolicy(bulkInput);
15                System.debug('Policies bulk cancelled successfully: ' + bulkData);
16                outputMap.put('bulkData', bulkData);
17            } catch (Exception e) {
18                System.debug('Error while bulk cancelling policies: ' + e.getMessage());
19                outputMap.put('error', e.getMessage());
20            }
21            return bulkData;
22        }
23
24        return null;
25    }
26}
27
28// Execute
29
30BulkCancelConnectDriver.callBulkCancelConnectAPI();