Renew Contract Action

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI

/services/data/v68.0/actions/standard/renewContract

Formats

JSON, XML

HTTP Methods

POST

Authentication

Authorization: Bearertoken

Inputs

Outputs

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        "enrollmentStartDate": "2026-03-11",
10        "enrollmentEndDate": "2026-04-11",
11        "targetContractId": "800xx0000004C92AAE",
12        "additionalFields": [
13          {
14            "entity": "Contract",
15            "productPath": "Root",
16            "fields": [
17              {
18                "key": "CustomerSignedTitle",
19                "value": "Mr"
20              }
21            ]
22          }
23        ]
24      }
25    }
26  ]
27}

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]