Endorse an insurance policy by using a set of user inputs that represent policy details.
This action is available in API version 63.0 and later.
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.
| 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. |
| Output | Details |
|---|---|
endorsedPolicyId | Type String Description ID of the endorsed insurance policy. |
Sample Request.
1{
2"inputs": [
3 {
4 "EndorsePolicyIAInputRep": {
5 "contextId": "5dbc40312f69b2d8cb4e7042a700d06f32fc5b9df7de3eabc94aa19a66ed77b3",
6 "policyId": "0YTxx00000001IfGAI",
7 "effectiveDate" : "2024-06-06",
8 "insurancePolicy": {
9 "policyName": "Endorsed Test Auto Ins policy",
10 "policyNumber": "PLC5678987"
11 },
12 "transactionRecord": {
13 "name": "Endorsed Policy Transaction"
14 },
15 "billingRecord":{
16 "billDayOfMonth": 15,
17 "billToContact": "003xx000000001aEAA"
18 },
19 "additionalInput": [
20 {
21 "instanceKey": "AutoBundle2",
22 "additionalFieldsList": [
23 {
24 "key":"AssetDescription__c",
25 "value": "Test_AssetDescription__c"
26 },
27 {
28 "key":"SourceSystem",
29 "value": "Test_SourceSystem"
30 }
31 ]
32 },
33 {
34 "instanceKey": "AutoDriver",
35 "additionalFieldsList":[
36 {
37 "key": "ParticipantName",
38 "value": "Test_ParticipantName"
39 },
40 {
41 "key":"Participant_Hometown__c",
42 "value": "Test_Participant_Hometown__c"
43 }
44 ]
45 },
46 {
47 "instanceKey": "AutoRoot",
48 "additionalFieldsList": [
49 {
50 "key": "Primary_Policy_Holder__c",
51 "value": "Test_Primary_Policy_Holder__c"
52 },
53 {
54 "key":"PolicyDescription",
55 "value": "Test_PolicyDescription"
56 }
57 ]
58 },
59 {
60 "instanceKey": "AutoBundle2_AutoComp1",
61 "additionalFieldsList": [
62 {
63 "key": "Coverage_Description__c",
64 "value": "Test_Coverage_Description__c"
65 },
66 {
67 "key": "Description",
68 "value": "Test_Description"
69 }
70 ]
71 }
72 ]
73 }
74
75 }
76 ]
77}Sample Response
1[
2 {
3 "actionName": "endorseInsurancePolicy",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "endorsedPolicyId": "0YTSG000000PgVV4A0"
10 },
11 "sortOrder": -1,
12 "version": 1
13 }
14]
j