Override Approval Work Item Action

Update an approval work item status with the approval admin decision and any comments that the approval admin added.

This action also validates if a user has required permissions to override an approval work item and update its status. Keep these considerations in mind when you use this invocable action.

  • The user must have the Approval Admin user permission.
  • This action enables approval admins to interject the approval decision for any assignee.
  • The status of the approval work item must be in Assigned status.

This action is available in API version 62.0 and later.

Supported REST HTTP Methods 

URI: /services/data/v68.0/actions/standard/overrideApprovalWorkItem

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs 

InputTypeDescription
approvalDecisionstringRequired. Action that the overriding approval admin made for the unreviewed approval work item. Valid values are approve or reject.
approvalWorkItemIdstringRequired. ID of the unreviewed approval work item to be reviewed by an approval admin.
channelTypepicklistType of channel where the request to review the approval work item originated. Valid values are InvocableAction, Slack, or ApprovalRecord. The default value is InvocableAction. Available in API version 65.0 and later.
commentsstringComments entered by the approval admin about their decision to approve or reject an unreviewed approval work item.

Outputs 

None.

Example 

POST

Here’s a sample request for the Override Approval Work Item action.

1{
2  "inputs": [
3    {
4      "approvalWorkItemId": "9jRxx00000001lhEAA",
5      "approvalDecision": "Reject",
6      "channelType": "InvocableAction",
7      "comments": "Needs to be reviewed."
8    }
9  ]
10}

Here’s a sample response for the Override Approval Work Item action.

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