Initiate Cancellation Action

This action is available in API version 60.0 and later.

Supported REST HTTP Methods

URI

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

Formats

JSON, XML

HTTP Methods

POST

Authentication

Authorization: Bearer token

Inputs

Outputs

Example

POST

This sample request is for the Initiate Cancellation action.

{
    "inputs": [
        {
            "cancelAssetIds": [
                "02iI8000000Lc5fIAC"
            ],
            "cancelStartDate": "2023-11-09T00:00:00",
            "cancelOutputType": "Quote",
            "cancelContractId" : "contract ID",
            "cancelOpportunityId" : "Opportunity ID"
        }
    ]
}

This sample response is for the Initiate Cancellation action.

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