Cancel a workflow session

URL

POST https://api.complycube.com/v1/workflowSessions/:id/cancel

Cancels an existing workflow session only when its current status is started. When the request succeeds, the workflow session status is updated to cancelled.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the workflow session.

Example request

cURL

curl -X POST https://api.complycube.com/v1/workflowSessions/{:wfSessionId}/cancel \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json'

Example response

Success (200)

{}

Resource Not Found (404)