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

Cancel an insurance policy.

Resource

1/connect/insurance/brokerage/policies/policyId/cancel

Resource example

1https://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

1{
2    "cancellationEffectiveDate": "2026-07-01",
3    "cancellationReason": "Non-payment",
4    "status": "Cancelled"
5}

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

Response body for PATCH

Insurance Policy Cancellation Response

Insurance Developer Guide

Cancel Policy (PATCH)