Review Approval Work Item Action

Update an approval work item status with the assignee or reviewer's decision and any comments that the assignee or reviewer added.

Keep these considerations in mind when you use this invocable action.

  • The user must be an assignee of the approval work item or be a member of a group or queue if the approval work item is assigned to the group or queue. Additionally, a user has access to Approval Submissions if they're a delegate of the assignee or has a role higher than the assignee.
  • The status of the approval work item must be in Assigned status.
  • The user can also use this action if inherited access to group or queue membership, nested group membership, roles hierarchy, or delegates is available. See Public Group Considerations.

This action is available in API version 62.0 and later.

Supported REST HTTP Methods

URI: /services/data/v66.0/actions/standard/reviewApprovalWorkItem

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
approvalDecision string Required. Action that the assigned approver made for the approval work item. Valid values: approve or reject.
approvalWorkItemId string Required. ID of the approval work item to be reviewed by the assigned approver.
channelType picklist Type of channel where the request to review the approval work item originated. Valid values: InvocableAction, Slack, or ApprovalRecord. The default value is InvocableAction. Available in API version 65.0 and later.
comments string Approval comments for the decision.

Outputs

None.

Example

POST

Here's a sample request for the Review Approval Work Item action.

1{
2  "inputs": [
3    {
4      "approvalWorkItemId": "9jRxx00000001lhEAA",
5      "approvalDecision": "Approve",
6      "channelType": "InvocableAction",
7      "comments": "Looks good."
8    }
9  ]
10}

Here's a sample response for the Review Approval Work Item action.

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