Insurance Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Endorse Insurance Policy (POST)
Endorse the latest version of the insurance policy based on the context ID and
effective date. You can also include other optional fields and additional details in the input
JSON.
- Resource
-
/connect/insurance/policies/policyId/endorse - Resource example
-
https://yourInstance.salesforce.com/services/data/v64.0/connect/insurance/policies/0YTxx00000000WHGAY/endorse - Available version
- 63.0
- HTTP methods
- POST
- Request body for POST
-
- JSON example
-
insurancePolicy":{ "policyName":"p2_endorse_name", "policyNumber":"p2_endorse_number", "effectiveDate": "2024-01-01" }, "transaction":{ "name":"New Endorsement" }, "additionalFields":{ "additionalFieldsList":[ { "additionalFieldsMapValue":{ "instanceKey":"autoRoot", "fields":{ "Checkbox__c":"true", "Currency__c":123456, "Date__c":"2024-11-30", "DateTime__c":"2024-12-31T01:34:00.000Z", "Email__c":"testuser@sf.com" } } } { "additionalFieldsMapValue":{ "instanceKey":"autoDriver", "fields":{ "TextEncr__c":"233345675676", "Url__c":"https://thisistest.com", "Time__c":"12:05:00.000Z" } } } ] } - 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 for endorsement. Required 63.0 effectiveDate String Date from when endorsed policy version is effective from. Required 63.0 insurancePolicy Insurance Policy Input[] The JSON structure that overrides the name and policy number of the endorsed policy version. Optional 63.0 transactionRecord Insurance Policy Transaction Input[] The JSON structure that overrides the transaction information. Optional 63.0
- Response body for POST
- Policy