Salesforce Docs Portal

Cancel Insurance Policy Action

Cancel an insurance policy by using a set of user inputs that represent policy details.

This action is available in API version 63.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/cancelInsurancePolicy

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input Details
cancelPolicyIAInputRep Type

Apex-defined

Description

An Apex ConnectApi.CancelPolicyIAInputRep record that contains details of the policy to be canceled.

Outputs

Output Details
cancelPolicyIAOutputRep Type

Apex-defined

Description

An Apex ConnectApi.CancelPolicyIAOutputRep record that contains the details of the policy that's canceled.

Example

Sample Request

{
   "inputs": [
       {
           "CancelPolicyIAInputRep": {
               "policyId": "0YTxx00000001H3GAI",
               "effectiveDate": "2024-09-08",              
               "transactionRecord":{                            
                   "name": "Cancel Transaction"
               }
           }
       }
   ]
}

Sample Response

{
  "actionName": "cancelInsurancePolicy",
  "errors": null,
  "invocationId": null,
  "isSuccess": true,
  "outcome": null,
  "outputValues": {
    "CancelPolicyIAOutputRep": {
      "impactedPolicyVersions": [
        "0YTSG000000PgSH4A0"
      ],
      "refund": {
        "premium": "133.4",
        "tax": "21.3",
        "fee": "32.3"
      },
      "sortOrder": -1,
      "version": 1
    }
  }
}