Reinstate Insurance Policy (POST)

If you want to calculate billing during insurance policy reinstatement, specify billingRecord details in the API request, and make sure that Career Billing is enabled in your org.

Resource

1/connect/insurance/policies/policyId/reinstate

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/insurance/policies/0YTxx0000004CdeFGH/reinstate

Available version

65.0

HTTP methods

POST

Path parameter for POST

Parameter Name	Type	Description	Required or Optional	Available Version
policyId	String	ID of the insurance policy to be reinstated.	Required	65.0

Request body for POST

JSON example

1{
2  "effectiveDate": "2025-09-15",
3  "insurancePolicy": {
4    "policyName": "Reinstate Auto Policy"
5  },
6  "transactionRecord": {
7    "name": "Reinstatement Transaction"
8  },
9"billingRecord": {
10    "billDayOfMonth": 15,
11    "billToContact": "003xx000000001aEAA"
12  },
13  "additionalFields": {
14    "additionalFieldsList": [
15      {
16        "additionalFieldsMapValue": {
17          "ReinstatementReason": "Payment Received"
18        }
19      }
20    ]
21  }
22}

Properties

Name	Type	Description	Required or Optional	Available Version
additionalFields	Additional Fields Map Value[]	JSON structure that’s used to add custom or standard fields to the InsurancePolicy, InsurancePolicyAsset, InsurancePolicyCoverage, and InsurancePolicyParticipant objects. The values for additionalFields take precedence over the context or the insurancePolicy parameter. Address and Geolocation field types are not supported as additional fields.	Optional	65.0
billingRecord	Insurance Policy Billing Details	Billing details to calculate billing when reinstating the policy.	Optional	67.0
effectiveDate	String	Date from the policy reinstatement becomes effective. This date must be within the policy term. For example, if the policy term is 2025-01-01 to 2025-12-31, and you set effectiveDate to 2025-03-01, the reinstatement applies starting March 1, 2025.	Optional	65.0
insurancePolicy	Insurance Policy Input	Details of the insurance policy. It contains fields and values from the Insurance Policy object.	Optional	65.0
transactionRecord	Insurance Policy Transaction Input	JSON structure that's used to override transaction information.	Optional	65.0

Response body for POST

Policy