Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Policy Administration
Insurance Policy Business APIs
Resources
Cancel Insurance Policy (POST)
Endorse Insurance Policy (POST)
Insurance Policy Details (GET)
Issue Insurance Policy (POST)
Out-of-Sequence Endorse Policy (POST)
Reinstate Insurance Policy (POST)
Renew Insurance Policy (POST)
Multi-Root Policy Issuance (POST)
Multi-Root Policy Endorsement (POST)
Multi-Root Policy Renewal (POST)
Requests
Responses
Insurance Policy Standard Invocable Actions
Insurance Policy Administration Metadata API Types
Insurance Policy Standard Objects
Insurance Policy Administration Apex Reference
Insurance Policy Developer Journey
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Cancel Insurance Policy (POST)

Cancel an insurance policy version. The API takes the effective date of cancellation from the input JSON. You can advance the cancellation date within the policy term, but you can’t postpone the cancellation.
Resource
1/connect/insurance/policies/policyId/cancel
Resource example
1https://yourInstance.salesforce.com/services/data/v66.0/connect/insurance/policies/0YTxx000000006TGAQ/cancel
Available version
63.0
HTTP methods
POST
Request body for POST
JSON example
1{
2   "effectiveDate": "2024-09-08",
3   "transactionRecord":{
4      "name" : "Cancel Transaction"
5   }
6}
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
Response body for POST
Cancel Policy