Endorse Insurance Policy (POST)

If you want to calculate billing during insurance policy endorsement 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/endorse

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/insurance/policies/0YTxx00000000WHGAY/endorse

Available version

63.0

HTTP methods

POST

Request body for POST

JSON example

1{
2  "contextId": "54920265842e1b61496c38b7e2202f6f0aff8123ad2f19fe17ac68f7fc1c60b3",
3  "effectiveDate": "2024-01-01",
4  "insurancePolicy": {
5    "policyName": "p2_endorse_name",
6    "policyNumber": "p2_endorse_number"
7  },
8  "transactionRecord": {
9    "name": "New Endorsement"
10  },
11 "billingRecord": {
12    "billDayOfMonth": 15,
13    "billToContact": "003xx000000001aEAA"
14  },
15  "additionalFields": {
16    "additionalFieldsList": [
17      {
18        "additionalFieldsMapValue": {
19          "instanceKey": "autoRoot",
20          "fields": {
21            "Checkbox__c": "true",
22            "Currency__c": 123456,
23            "Date__c": "2024-11-30",
24            "DateTime__c": "2024-12-31T01:34:00.000Z",
25            "Email__c": "testuser@sf.com"
26          }
27        }
28      },
29      {
30        "additionalFieldsMapValue": {
31          "instanceKey": "autoDriver",
32          "fields": {
33            "TextEncr__c": "233345675676",
34            "Url__c": "https://thisistest.com",
35            "Time__c": "12:05:00.000Z"
36          }
37        }
38      }
39    ]
40  }
41}

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 endorsing the policy.	Optional	67.0
contextId	String	Context ID of the quote that’s used for endorsement.	Required	63.0
effectiveDate	String	Date from when the endorsed policy version is effective.	Required	63.0
insurancePolicy	Insurance Policy Input[]	JSON structure that overrides the name and policy number of the endorsed policy version.	Optional	63.0
transactionRecord	Insurance Policy Transaction Input[]	JSON structure that overrides the transaction information.	Optional	63.0

Response body for POST

Policy