Recall Approval Submission Action

Recall an approval submission that isn't completed. You can also add comments that the submitter or approval admin made the recall.

This action also validates if a user has required permissions to recall an approval submission. Keep these considerations in mind when you use this invocable action.

  • The user must have the Approval Admin user permission.
  • The user must also be a submitter of this approval submission.
  • 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/v67.0/actions/standard/recallApprovalSubmission
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearertoken

Inputs

Input Details
approvalSubmissionId
Type

string

Description

Required.

ID of the approval submission to be recalled.

comments
Type

string

Description
Comments entered by the approval admin or approval submitter about why they recalled the approval submission.

Outputs

None.

Example

POST

Here's a sample request for the Recall Approval Submission action.

1{
2  "inputs": [
3    {
4      "approvalSubmissionId": "9iPxx00000001lhEBA",
5      "comments": "Recall comments."
6    }
7  ]
8}

Here's a sample response for the Recall Approval Submission action.

1{
2  "actionName": "recallApprovalSubmission",
3  "errors": null,
4  "invocationId": null,
5  "isSuccess": true,
6  "outcome": null,
7  "outputValues": null,
8  "sortOrder": -1,
9  "version": 1
10}