Cancel Policy (PATCH)

Cancel an insurance policy.

Resource 

{policyId} is a placeholder.

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

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

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 NameTypeDescriptionRequired or Optional
policyIdIdID 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 

NameTypeDescriptionRequired or OptionalAvailable Version
cancellationEffectiveDateStringDate after which the policy is no longer valid. Use the format YYYY-MM-DD.Required67.0
cancellationReasonStringReason for canceling the insurance policy.Optional67.0
statusStringTarget status of the canceled policy, such as Canceled.Optional67.0

Response Body for PATCH 

Insurance Policy Cancellation Response