This action is available in API version 63.0 and later.
Supported REST HTTP Methods
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.
Inputs
| Input | Details |
|---|---|
| renewPolicyIAInputRep |
Type
Apex-defined Description An Apex ConnectApi.RenewPolicyIAInputRep record that contains the details of the policy to be renewed. |
Outputs
| Output | Details |
|---|---|
| renewedPolicyId |
Type
String DescriptionID of the renewed policy. |
Example
Sample Request
{
"inputs": [
{
"RenewPolicyIAInputRep": {
"contextId": "d767b27ec095f9f95c5a34299e3bd6f507df23e8d0692dfed17f98dcb5b661b6",
"policyId": "0YTxx00000001ovGAA",
"insurancePolicy": {
"policyName": "Renewed_Auto_Policy_00002",
"policyNumber": "Renewed Auto Policy 00002",
"effectiveFromDate": "2025-01-01",
"effectiveToDate": "2025-12-31"
},
"transactionRecord": {
"name": "Renew 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": "renewInsurancePolicy",
"errors": null,
"invocationId": null,
"isSuccess": true,
"outcome": null,
"outputValues": {
"renewedPolicyId": "0YTSG000000PgX74AK"
},
"sortOrder": -1,
"version": 1
}
]