Cancel an insurance policy.
Resource
{policyId} is a placeholder.
/connect/insurance/brokerage/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/brokerage/policies/0YTxx0000000001GAA/cancel
Available Version
67.0
HTTP Methods
PATCH
Request Parameters for PATCH
| Parameter Name | Type | Description | Required or Optional |
|---|---|---|---|
| policyId | Id | ID of the insurance policy to cancel. The key prefix is 0YT. | Required |
Request Body for PATCH
JSON Example
{
"cancellationEffectiveDate": "2026-07-01",
"cancellationReason": "Non-payment",
"status": "Cancelled"
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cancellationEffectiveDate | String | Date after which the policy is no longer valid. Use the format YYYY-MM-DD. | Required | 67.0 |
| cancellationReason | String | Reason for canceling the insurance policy. | Optional | 67.0 |
| status | String | Target status of the canceled policy, such as Canceled. | Optional | 67.0 |