Workflow Instances End API - Jodoo

Workflow Instances End APIAPI Explorer

Introduction

The API is used by the admin to end the current workflow instance.

The API is used by the admin to end the current workflow instance.

Request URL: https://api.jodoo.com/api/v1/workflow/instance/close

Request Frequency: 20 times/second

Request Method: POST

Request Parameters:

Parameter	Required	Type	Description
instance_id	Yes	String	Instance ID is the same as data_id. End the corresponding workflow instance.

Sample Request:

{
    "instance_id": "6358a65878b1fb0007aba61b"
}

Response Parameters:

Parameter	Type	Description
status	String	success: indicating that the API call is successful failure: Indicating that the API call failed (with the error code and its description)
code	Number	Error code
message	String	Description of return code

Sample Responses:

Success Response Sample

{
    "status": "success"
}

Failure Response Sample

{
    "code": 4008,
    "message": "Action failed. Workflow is closed",
    "status": "failure"
}