Initiate Renewal Action

Initiate and execute the renewal of an asset.

Specify the IDs of the assets that you want to add to renew by specifying a start date. You can also specify the type of renewal record that you want to create, such as a quote or an order.

This action is available in API version 60.0 and later.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/initiateRenewal

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`rampOptionsDetails`	Apex-defined	An Apex RampOptionInputRepresentation record that contains the details of ramp options. The details include segment type, duration, and segment count. Specify this property if you want to include assets in a group ramp with a ramp schedule. See RampOptionInputRepresentation to refer to the associated properties for ramp options. Available in API version 67.0 and later.
`renewAssetIds`	string	Required. The IDs of the assets that you want to renew.
`renewContractId`	string	ID of the contract record to sync with the renewal quote.
`renewEndDate`	datetime	Effective end date of the renewal. Available in API version 62.0 and later.
`renewOpportunityId`	string	ID of the Opportunity record to sync with the renewal quote.
`renewOutputType`	string	Required. Type of renewal record to create such as a quote or an order.
`renewStartDate`	datetime	Optional. Effective start date of the renewal. Required for early asset renewals and renewing expired assets, by using today’s date or a future date. Available in API version 62.0 and later.
`skipPricing`	boolean	Indicates whether the pricing procedure must be skipped (`true`) or performed (`false`). Available in API version 64.0 and later.

Outputs

Output	Type	Description
`renewRecordId`	string	The ID of the amendment record that’s created.
`requestIdentifier`	string	Request ID that’s used to track the async request.

Example

POST

This sample request is for the Initiate Renewal action.

1{
2  "inputs": [
3    {
4      "rampOptionsDetails": {
5        "segmentType": "Custom",
6        "duration": 40,
7        "numberOfSegments": 10
8      },
9      "renewAssetIds": [
10        "02ixx0000004LMwAAM"
11      ],
12      "renewOutputType": "Quote",
13      "renewContractId": "800DU0000000lZlYAI",
14      "renewOpportunityId": "006DU0000025AanYAE",
15      "renewStartDate": "2023-10-21T00:00:00.000Z",
16      "renewEndDate": "2024-10-21T00:00:00.000Z",
17      "skipPricing": false
18    }
19  ]
20}

This sample response is for the Initiate Renewal action.

1[
2    {
3        "actionName": "initiateRenewal",
4        "errors": null,
5        "isSuccess": true,
6        "outputValues": {
7            "renewRecordId": "0Q0xx0000004P32CAE",
8            "requestIdentifier": "16Pxx0000004OTY"
9        },
10        "version": 1
11    }
12]