Multi-Root Policy Issuance (POST)

Asynchronoulsy create a multi-root insurance policy along with its child policies. A multi-root policy includes multiple child policies of different product types under a single parent policy.

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

Resource

1/connect/insurance/policies/multi-root

Resource example

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

Available version

66.0

HTTP methods

POST

Request body for POST

JSON example

1{
2    "contextId": "3561319f267fd53380bc38c049a01c8089876e833a321860766d35a9c40b67df",
3    "insurancePolicy": {
4        "policyName": "Mr. Bret Lees Policy",
5        "policyNumber": "Policy-Bret-OneYear",
6        "effectiveFromDate": "2024-01-01",
7        "effectiveToDate": "2024-10-31"
8    },
9    "transactionRecord": {
10        "name": "New Policy"
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. Address and Geolocation field types are not supported as additional fields. Add the SourceQuoteId standard field to the additionalFields option when the context ID in the input JSON for the Issue Insurance Policy API or the Multiroot Issue Inurance Policy API is generated by the Create Insurance Quote API.	Optional	63.0
`billingRecord`	Insurance Policy Billing Details	Billing details to calculate billing when issuing the policy.	Required if Career Billing is enabled in your org	67.0
`contextId`	String	Context ID of the policy or quote that’s used to create the policy.	Required	63.0
`insurancePolicy`	Insurance Policy Input[]	JSON structure that’s used to create 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 transaction information.	Optional	63.0

Response body for POST

Multi-Root Policy Asynchronous Response

Insurance Developer Guide

Multi-Root Policy Issuance (POST)