Renew Contract Action

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.

1{
2  "inputs": [
3    {
4      "insuranceContractRenewInputRepresentation": {
5        "quoteId": "0Q0xx0000004CtoCAE",
6        "renewalDate": "2026-03-11",
7        "contractEndDate": "2027-03-11",
8        "contractTerm": 12,
9        "targetContractId": "800xx0000004C92AAE",
10        "additionalFields": [
11          {
12            "entity": "Contract",
13            "productPath": "Root",
14            "fields": [
15              {
16                "key": "CustomerSignedTitle",
17                "value": "Mr"
18              }
19            ]
20          }
21        ]
22      }
23    }
24  ]
25}

This sample response is for the Renew Contract action.

1[
2  {
3    "actionName": "renewContract",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "insuranceContractRenewOutputRepresentation": {
10        "errors": [],
11        "isSuccess": true,
12        "message": "Contract renewed successfully from quote.",
13        "contractId": "800xx0000004C92AAE"
14      }
15    },
16    "sortOrder": -1,
17    "version": 1
18  }
19]