Initiate Renewal Action

This action is available in API version 60.0 and later.

Supported REST HTTP Methods

URI

/services/data/v63.0/actions/standard/initiateRenewal

Formats

JSON, XML

HTTP Methods

POST

Authentication

Authorization: Bearer token

Inputs

Outputs

Example

POST

This sample request is for the Initiate Renewal action.

{
    "inputs": [
        {
            "renewAssetIds": ["02ixx0000004LMwAAM"],
            "renewOutputType": "Quote",
            "renewContractId" : "contract ID",
            "renewOpportunityId" : "Opportunity ID",
            "renewStartDate": "2023-10-21T00:00:00.000Z",
            "renewEndDate": "2024-10-21T00:00:00.000Z"
        }
    ]
}

This sample response is for the Initiate Renewal action.

[
    {
        "actionName": "initiateRenewal",
        "errors": null,
        "isSuccess": true,
        "outputValues": {
            "record_id": "0Q0xx0000004P32CAE",
            "requestIdentifier": "16Pxx0000004OTY"
        },
        "version": 1
    }
]