This action is available in API version 63.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/endorseInsurancePolicy
Where XX.X is the latest API version.
Formats: JSON
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is your OAuth access token.
Inputs
| Input | Details |
|---|---|
| endorsePolicyIAInputRep |
Type
Apex-defined Description An Apex ConnectApi.EndorsePolicyIAInputRep record that contains the details of the policy to be endorsed. To calculate billing, specify billingRecord details if Career Billing is enabled in your org. |
Outputs
| Output | Details |
|---|---|
| endorsedPolicyId |
Type
String DescriptionID of the endorsed insurance policy. |
Example
Sample Request.
{
"inputs": [
{
"EndorsePolicyIAInputRep": {
"contextId": "5dbc40312f69b2d8cb4e7042a700d06f32fc5b9df7de3eabc94aa19a66ed77b3",
"policyId": "0YTxx00000001IfGAI",
"effectiveDate" : "2024-06-06",
"insurancePolicy": {
"policyName": "Endorsed Test Auto Ins policy",
"policyNumber": "PLC5678987"
},
"transactionRecord": {
"name": "Endorsed Policy Transaction"
},
"billingRecord":{
"billDayOfMonth": 15,
"billToContact": "003xx000000001aEAA"
},
"additionalInput": [
{
"instanceKey": "AutoBundle2",
"additionalFieldsList": [
{
"key":"AssetDescription__c",
"value": "Test_AssetDescription__c"
},
{
"key":"SourceSystem",
"value": "Test_SourceSystem"
}
]
},
{
"instanceKey": "AutoDriver",
"additionalFieldsList":[
{
"key": "ParticipantName",
"value": "Test_ParticipantName"
},
{
"key":"Participant_Hometown__c",
"value": "Test_Participant_Hometown__c"
}
]
},
{
"instanceKey": "AutoRoot",
"additionalFieldsList": [
{
"key": "Primary_Policy_Holder__c",
"value": "Test_Primary_Policy_Holder__c"
},
{
"key":"PolicyDescription",
"value": "Test_PolicyDescription"
}
]
},
{
"instanceKey": "AutoBundle2_AutoComp1",
"additionalFieldsList": [
{
"key": "Coverage_Description__c",
"value": "Test_Coverage_Description__c"
},
{
"key": "Description",
"value": "Test_Description"
}
]
}
]
}
}
]
}
Sample Response
[
{
"actionName": "endorseInsurancePolicy",
"errors": null,
"invocationId": null,
"isSuccess": true,
"outcome": null,
"outputValues": {
"endorsedPolicyId": "0YTSG000000PgVV4A0"
},
"sortOrder": -1,
"version": 1
}
]