Cancel an insurance policy version. You can advance the cancellation date within the
policy term, but you can’t postpone the cancellation.
Resource
{policyId} is a placeholder.
/connect/insurance/policies/{policyId}/cancel
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{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
{
"effectiveDate": "2024-09-08",
"transactionRecord":{
"name" : "Cancel Transaction"
}
}
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 |