Renew 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/renewInsurancePolicy
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 |
|---|---|
renewPolicyIAInputRep | Type Apex-defined Description An Apex ConnectApi.RenewPolicyIAInputRep record that contains the details of the policy to be renewed. |
| Output | Details |
|---|---|
renewedPolicyId | Type String Description ID of the renewed policy. |
Sample Request
1{
2 "inputs": [
3 {
4 "RenewPolicyIAInputRep": {
5 "contextId": "d767b27ec095f9f95c5a34299e3bd6f507df23e8d0692dfed17f98dcb5b661b6",
6 "policyId": "0YTxx00000001ovGAA",
7 "insurancePolicy": {
8 "policyName": "Renewed_Auto_Policy_00002",
9 "policyNumber": "Renewed Auto Policy 00002",
10 "effectiveFromDate": "2025-01-01",
11 "effectiveToDate": "2025-12-31"
12 },
13 "transactionRecord": {
14 "name": "Renew Transaction"
15 },
16 "billingRecord": {
17 "billDayOfMonth": 15,
18 "billToContact": "003xx000000001aEAA"
19 },
20 "additionalInput": [
21 {
22 "instanceKey": "AutoBundle2",
23 "additionalFieldsList": [
24 {
25 "key": "AssetDescription__c",
26 "value": "Test_AssetDescription__c"
27 },
28 {
29 "key": "SourceSystem",
30 "value": "Test_SourceSystem"
31 }
32 ]
33 },
34 {
35 "instanceKey": "AutoDriver",
36 "additionalFieldsList": [
37 {
38 "key": "ParticipantName",
39 "value": "Test_ParticipantName"
40 },
41 {
42 "key": "Participant_Hometown__c",
43 "value": "Test_Participant_Hometown__c"
44 }
45 ]
46 },
47 {
48 "instanceKey": "AutoRoot",
49 "additionalFieldsList": [
50 {
51 "key": "Primary_Policy_Holder__c",
52 "value": "Test_Primary_Policy_Holder__c"
53 },
54 {
55 "key": "PolicyDescription",
56 "value": "Test_PolicyDescription"
57 }
58 ]
59 },
60 {
61 "instanceKey": "AutoBundle2_AutoComp1",
62 "additionalFieldsList": [
63 {
64 "key": "Coverage_Description__c",
65 "value": "Test_Coverage_Description__c"
66 },
67 {
68 "key": "Description",
69 "value": "Test_Description"
70 }
71 ]
72 }
73 ]
74 }
75 }
76 ]
77}Sample Response
1[
2 {
3 "actionName": "renewInsurancePolicy",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "renewedPolicyId": "0YTSG000000PgX74AK"
10 },
11 "sortOrder": -1,
12 "version": 1
13 }
14]
j