Activating a Flow Using the API

This use case covers using the WISEflow API to activate a flow. It does not cover how to find the flowId which is described in this article.

This use case is ideal for institutions relying on the WISEflow API and has built their own middleware to control key aspects of WISEflow.

Activating a Flow

The PATCH /flows/{flowId}/activate endpoint is used to archive flows. With the flowId as the parameter, it is possible to activate a flow from the Setup state.

After successfully activating a flow, the response will return:

{
  "success": true,
  "data": null,
  "error": null
}

If you are trying to activate that has already been activated, the response will return:

{
  "success": false,
  "data": null,
  "error": {
    "code": "403",
    "message": "Only inactive flows can be activated",
    "errors": []
    }
}