Cancel Approval Submission Action
Cancels an approval submission and all child approval work items
that haven't been completed. You can also add comments about why the approval admin made
the cancellation.
This action also validates if a user has required permissions to cancel an approval submission. Keep these considerations in mind when you use this invocable action.
- The user must have the Approval Admin user permission.
- The status of the approval submission must be in In progress or Suspended status.
This action is available in API version 62.0 and later.
Supported REST HTTP Methods
URI: /services/data/v66.0/actions/standard/cancelApprovalSubmission
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| approvalSubmissionId | string | Required. ID of the Approval Submission to be canceled. |
| comments | string | Comments entered by the approval admin about why they canceled the Approval Submission. |
Outputs
None.
Example
POST
Here's a sample request for the Cancel Approval Submission action.
1{
2 "inputs": [
3 {
4 "approvalSubmissionId": "9iPxx00000001lhEBA",
5 "comments": "Cancellation comments."
6 }
7 ]
8}Here's a sample response for the Cancel Approval Submission action.
1{
2 "actionName": "cancelApprovalSubmission",
3 "errors": null,
4 "invocationId": null,
5 "isSuccess": true,
6 "outcome": null,
7 "outputValues": null,
8 "sortOrder": -1,
9 "version": 1
10}