Update application status

Change an application's stage. Optionally approve it and continue its flow, the same way Approve works on the Agent Dashboard.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Default: set the stage only

Without rerun_flow, this call only changes the application's stage and adds an entry to its activity, for example "Application is set to Review using Update Status API." It does not run decision trees or providers, send emails or fire webhooks. Setting stage 1 (Approved) or 2 (Declined) this way changes only the stage label; the application is not approved or declined.

Approve and continue the flow (rerun_flow)

Send stage: 1 with rerun_flow: true to approve the application the same way Approve works on the Agent Dashboard. Any approve_variable_data is merged into the application first. If the application was in review or document request and the chosen outcome has a child decision tree, that tree runs; otherwise the flow continues from the current step. The application.approved webhook fires when the application ends up approved.

Environment and access

A key that starts with live_ updates live applications; any other key (for example test_) updates sandbox applications. An application from the other environment returns Invalid App Id. The application must belong to the same account as your API key, or the call returns 403.


Body Params
string
required

This is the UUID of the application.

integer
required

The stage to set. A numeric string such as "4" is also accepted. Built-in stages: 0 Processing, 1 Approved, 2 Declined, 3 Document, 4 Review, 5 Booked, 6 Withdrawn, 7 Doc Received, 8 Completed, 9 Default, 10 Closed, 11 Pre-Qualify. Your account's custom stage IDs are also accepted.

boolean
Defaults to false

Only with stage 1. Approves the application and continues its flow, the same way Approve works on the Agent Dashboard. true, "true" and 1 all turn it on.

integer

Only used with rerun_flow. The ID of an active outcome in your account to record with the approval.

string

Only used with rerun_flow. Added to the application's activity entry.

approve_variable_data
object

Only used with rerun_flow. Variables to merge into the application's data before it is approved. A JSON string of an object is also accepted.

Responses

401

An invalid or inactive Bearer token. No response body is returned. A request with no Authorization header is 403, not 401.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json