Asset Renewal (POST)

Initiate and execute the renewal of an asset.

Special Access Rules

To use this API, you need the InitiateRenewal API permission set.

Resource

1/connect/revenue-management/assets/actions/renew

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue-management/assets/actions/renew

Available Version

62.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "assetIds": [
3    "02iSG0000003NMhYAM",
4    "02iSG0000006DvSYAU"
5  ],
6  "contractId": "800SG00000CFpepYAD",
7  "opportunityId": "006SG000004W5tVYAS",
8  "outputRecordId": "801SG00000DX1jWYAT",
9  "outputRecordType": "Quote",
10  "renewalEndDate": "2024-10-03T23:59:59",
11  "renewalStartDate": "2023-10-04T00:00:00"
12}

Properties

Name	Type	Description	Required or Optional	Available Version
`assetIds`	String[]	IDs of the assets that you want to renew.	Required	62.0
`contractId`	String	ID of the Contract record that you want to sync with the renewal of the Quote or Order record.	Optional	62.0
`opportunityId`	String	ID of the Opportunity record that you want to sync with the renewal quote.	Optional	62.0
`outputRecordId`	String	ID of the Quote or Order record that you want to renew.	Optional	62.0
`outputRecordType`	String	Type of renewal record that you want to create.	Required	62.0
`renewalEndDate`	String	End date of the renewal process for the assets.	Optional	62.0
`renewalStartDate`	String	Start date of the renewal process for the assets. Required for early asset renewals and renewing expired assets, using today’s date or a future date.	Optional	62.0

Response Body for POST

Renewal