Multi-Root Policy Renewal (POST)

Asynchronously renew a multi-root insurance policy, create renewed records for the parent policy and the associated child policies.

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

Resource

1/connect/insurance/policies/policyId/multi-root/renew

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/insurance/policies/0YTxx00000000WHGAY/multi-root/renew

Path parameter for POST

Parameter Name	Type	Description	Required or Optional
`policyId`	String	ID of the policy that must be renewed along with its associated child policies.	Required

Available version

66.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"billingRecord": {
13    "billDayOfMonth": 15,
14    "billToContact": "003xx000000001aEAA"
15  },
16"additionalFields":{
17      "additionalFieldsList":[
18         {
19            "additionalFieldsMapValue":{
20               "instanceKey":"autoRoot",
21               "fields":{
22                  "Checkbox__c":"true",
23                  "Currency__c":123456,
24                  "Date__c":"2024-11-30",
25                  "DateTime__c":"2024-12-31T01:34:00.000Z",
26                  "Email__c":"testuser@sf.com"
27               }
28            }
29         }
30
31  {
32           "additionalFieldsMapValue":{
33             "instanceKey":"autoDriver",
34              "fields":{
35                 "TextEncr__c":"233345675676",
36                 "Url__c":"https://thisistest.com",
37                  "Time__c":"12:05:00.000Z"
38           }
39        }
40     }
41      ]
42   }
43}

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` JSON. This is applicable only for the endorsed policy version. Address and Geolocation field types are not supported as additional fields.	Optional	63.0
`billingRecord`	Insurance Policy Billing Details	Billing details to calculate billing when renewing the policy.	Optional	67.0
`contextId`	String	Priced context ID of the policy or quote that's used to renew the policy.	Required	63.0
`insurancePolicy`	Insurance Policy Input[]	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[]	JSON structure that's used to override the transaction information.	Optional	63.0

Response body for POST

Multi-Root Policy Asynchronous Response

Insurance Developer Guide

Multi-Root Policy Renewal (POST)