Update approval status

You can use the updateStatus method to update the status of an approval. This method allows you to set the status of an approval to Approved, Rejected, Reassign, or OnHold for the specified approval request ID. The updateStatus method returns the status 200 when it updates the approval successfully.

URL

The following URL is the syntax for the updateStatus method:

PUT rx/application/approval/single/{identifier}

Related topics

Get-approvals-list

Get-single-approval

Get-approval-signature

Search-approval-by-user-and-by-search-text

Adding-an-approval-process-to-an-application

Parameters

The following query parameters are supported by the updateStatus method:

Parameter

Description

Example

command

(Required) Specifies the approval status in this parameter. You can specify the status as Approved, Rejected, Reassign, or OnHold.

PUT rx/application/approval/single/{identifier}

{

 "command":"Rejected",

}

justificationOrReason

Specifies your comment for the approval status . This parameter is optional for all approval statuses except the Rejected status.

If you provide the status as Rejected in the command parameter, you must provide the justification comment.

PUT rx/application/approval/single/{identifier}{
 "command":"Approved",
 "justificationOrReason":"CanbeApproved"
}

assignToApprovers

Specifies the approver name when the status is Reassign.

When you specify the status as Reassign, in this parameter you must provide the approver name to whom the request needs to be assigned.

This parameter supports only one user. You cannot reassign the approval to multiple users.

PUT rx/application/approval/single/{identifier}

{

"command":"Reassign",

"assignToApprovers:"Approver names to whom request needs to be reassigned"

}


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*