Initiate Cancellation Action

Initiate and execute the cancellation of an asset.

Specify the IDs of the assets that you want to add to cancel by specifying a start date. You can also specify the type of cancellation 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/initiateCancellation

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`cancelAssetIds`	string	Required. The IDs of the assets that you want to cancel. All assets in a request must belong to the same price book.
`cancelContractId`	string	The ID of the contract record to sync with the cancellation.
`cancelOpportunityId`	string	The ID of the Opportunity record to sync with the cancellation quote.
`cancelOutputType`	string	Required. Type of cancellation record to create such as a quote or an order.
`cancelStartDate`	datetime	Required. Effective date of the cancellation.
`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
`cancelRecordId`	string	The ID of the cancellation 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 Cancellation action.

1{
2    "inputs": [
3        {
4            "cancelAssetIds": [
5                "02iI8000000Lc5fIAC"
6            ],
7            "cancelStartDate": "2023-11-09T00:00:00",
8            "cancelOutputType": "Quote",
9            "cancelContractId": "800DU0000000lZlYAI",
10            "cancelOpportunityId": "006DU0000025AanYAE",
11            "skipPricing": false
12        }
13    ]
14}

This sample response is for the Initiate Cancellation action.

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