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 Policy (POST)

Cancel an insurance policy version. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation.
Resource
1/connect/insurance/policies/policyId/cancel
Resource example
1https://yourInstance.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx000000006TGAQ/cancel
Available version
63.0
HTTP methods
POST
Request body for POST
JSON example
1{
2   "effectiveDate": "2024-09-08",
3   "transactionRecord":{
4      "name" : "Cancel Transaction"
5   }
6}
Properties
Name Type Description Required or Optional Available Version
effectiveDate String Date on which the cancellation of the policy goes into effect. Required 63.0
transactionRecord Insurance Policy Transaction Input[] The JSON structure that overrides the transaction information. Optional 63.0
Response body for POST
Cancel Policy