Renew a group insurance contract by creating a new contract for the next term from a
renewal quote, carrying forward the relevant contract details and line items.
This action is available in API version 68.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/renewContract
Where XX.X is the latest API version.
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is your OAuth access token.
Inputs
| Input | Type | Description |
|---|---|---|
| insuranceContractRenewInputRepresentation | Apex-defined | Required. An Apex ConnectApi.InsuranceContractRenewalInputRepresentation record that contains the renewal quote details to renew an insurance contract. |
Outputs
| Output | Type | Description |
|---|---|---|
| insuranceContractRenewOutputRepresentation | Apex-defined | An Apex ConnectApi.InsuranceContractRenewalRepresentation record that contains the result of the contract renewal operation, including the new contract ID. |
Example
POST
This sample request is for the Renew Contract action.
{
"inputs": [
{
"insuranceContractRenewInputRepresentation": {
"quoteId": "0Q0xx0000004CtoCAE",
"renewalDate": "2026-03-11",
"contractEndDate": "2027-03-11",
"contractTerm": 12,
"targetContractId": "800xx0000004C92AAE",
"additionalFields": [
{
"entity": "Contract",
"productPath": "Root",
"fields": [
{
"key": "CustomerSignedTitle",
"value": "Mr"
}
]
}
]
}
}
]
}
This sample response is for the Renew Contract action.
[
{
"actionName": "renewContract",
"errors": null,
"invocationId": null,
"isSuccess": true,
"outcome": null,
"outputValues": {
"insuranceContractRenewOutputRepresentation": {
"errors": [],
"isSuccess": true,
"message": "Contract renewed successfully from quote.",
"contractId": "800xx0000004C92AAE"
}
},
"sortOrder": -1,
"version": 1
}
]