Newer Version Available
Endorse Insurance Policy Action
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.
Supported REST HTTP Methods
URI
/services/data/v65.0/actions/standard/endorseInsurancePolicy
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token
Inputs
| Input | Details |
|---|---|
| endorsePolicyIAInputRep |
Type Apex class Description An Apex ConnectApi.EndorsePolicyIAInputRep record that contains the details of the policy to be endorsed. |
Outputs
| Output | Details |
|---|---|
| endorsedPolicyId |
Type String DescriptionThe ID of the endorsed insurance policy. |
Example
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 "additionalInput": [
16 {
17 "instanceKey": "AutoBundle2",
18 "additionalFieldsList": [
19 {
20 "key":"AssetDescription__c",
21 "value": "Test_AssetDescription__c"
22 },
23 {
24 "key":"SourceSystem",
25 "value": "Test_SourceSystem"
26 }
27 ]
28 },
29 {
30 "instanceKey": "AutoDriver",
31 "additionalFieldsList":[
32 {
33 "key": "ParticipantName",
34 "value": "Test_ParticipantName"
35 },
36 {
37 "key":"Participant_Hometown__c",
38 "value": "Test_Participant_Hometown__c"
39 }
40 ]
41 },
42 {
43 "instanceKey": "AutoRoot",
44 "additionalFieldsList": [
45 {
46 "key": "Primary_Policy_Holder__c",
47 "value": "Test_Primary_Policy_Holder__c"
48 },
49 {
50 "key":"PolicyDescription",
51 "value": "Test_PolicyDescription"
52 }
53 ]
54 },
55 {
56 "instanceKey": "AutoBundle2_AutoComp1",
57 "additionalFieldsList": [
58 {
59 "key": "Coverage_Description__c",
60 "value": "Test_Coverage_Description__c"
61 },
62 {
63 "key": "Description",
64 "value": "Test_Description"
65 }
66 ]
67 }
68 ]
69 }
70
71 }
72 ]
73}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]