Renew Insurance Policy (POST)

Use the context ID of an existing policy to renew a policy. Modify the renewal date and also add optional fields and additional information in the input JSON.

Resource

1/connect/insurance/policies/policyId/renew

Resource example

1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/policies/0YTxx00000000WHGAY/renew

Available version

63.0

HTTP methods

POST

Request body for POST

JSON example

1{
2 "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3",
3 "insurancePolicy": {
4   "policyName": "Demo Test Policy 9",
5   "policyNumber": "test renew policy",
6   "effectiveFromDate": "2025-03-15",
7   "effectiveToDate": "2026-03-15"
8 },
9 "transactionRecord":{
10   "name": "Renew Payment"
11 },
12"additionalFields":{
13      "additionalFieldsList":[
14         {
15            "additionalFieldsMapValue":{
16               "instanceKey":"autoRoot",
17               "fields":{
18                  "Checkbox__c":"true",
19                  "Currency__c":123456,
20                  "Date__c":"2024-11-30",
21                  "DateTime__c":"2024-12-31T01:34:00.000Z",
22                  "Email__c":"testuser@sf.com"
23               }
24            }
25         }
26
27  {
28           "additionalFieldsMapValue":{
29             "instanceKey":"autoDriver",
30              "fields":{
31                 "TextEncr__c":"233345675676",
32                 "Url__c":"https://thisistest.com",
33                  "Time__c":"12:05:00.000Z"
34           }
35        }
36     }
37      ]
38   }
39}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalFields`	Additional Fields Map Value[]	The 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 JSON.This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields.	Optional	63.0
`contextId`	String	Context ID of the quote that's used to renew the policy.	Required	63.0
`insurancePolicy`	Insurance Policy Input[]	The JSON structure that’s used to renew the policy. It contains fields and values from the Insurance Policy object.	Optional	63.0
`transactionRecord`	Insurance Policy Transaction Input[]	The JSON structure that's used to override the transaction information.	Optional	63.0

Response body for POST

Policy

Insurance Developer Guide

Renew Insurance Policy (POST)