Newer Version Available

This content describes an older version of this product. View Latest

Renew Insurance Policy Action

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.

Supported REST HTTP Methods

URI

/services/data/v63.0/actions/standard/renewInsurancePolicy

Formats

JSON

HTTP Methods

POST

Authentication

Authorization: Bearer token

Inputs

Input Details
renewPolicyIAInputRep Type

Apex class

Description

An Apex ConnectApi.RenewPolicyIAInputRep record that contains the details of the policy to be renewed.

Outputs

Output Details
renewedPolicyId Type

String

Description

The ID of the renewed policy.

Usage

JSON 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        "additionalInput": [
17          {
18            "instanceKey": "AutoBundle2",
19            "additionalFieldsList": [
20              {
21                "key": "AssetDescription__c",
22                "value": "Test_AssetDescription__c"
23              },
24              {
25                "key": "SourceSystem",
26                "value": "Test_SourceSystem"
27              }
28            ]
29          },
30          {
31            "instanceKey": "AutoDriver",
32            "additionalFieldsList": [
33              {
34                "key": "ParticipantName",
35                "value": "Test_ParticipantName"
36              },
37              {
38                "key": "Participant_Hometown__c",
39                "value": "Test_Participant_Hometown__c"
40              }
41            ]
42          },
43          {
44            "instanceKey": "AutoRoot",
45            "additionalFieldsList": [
46              {
47                "key": "Primary_Policy_Holder__c",
48                "value": "Test_Primary_Policy_Holder__c"
49              },
50              {
51                "key": "PolicyDescription",
52                "value": "Test_PolicyDescription"
53              }
54            ]
55          },
56          {
57            "instanceKey": "AutoBundle2_AutoComp1",
58            "additionalFieldsList": [
59              {
60                "key": "Coverage_Description__c",
61                "value": "Test_Coverage_Description__c"
62              },
63              {
64                "key": "Description",
65                "value": "Test_Description"
66              }
67            ]
68          }
69        ]
70      }
71    }
72  ]
73}