Skip to main content
POST
Cancel the execution of a case that is still running. The case ends with status CANCELLED, which Get Case Status will return from then on.
Only a case that has been executed and has not yet reached a terminal status can be cancelled.

Path Parameters

string
required
The case ID returned by Initiate Case

Headers

string
required
Your API authentication key

Response

string
required
Status of the case after the cancel. Always CANCELLED.

Errors

Bad Request
The case was never executed, so there is nothing to cancel.
Unauthorized
Missing, invalid, or expired API key.
Not Found
The case does not exist.
Conflict
The case has already ended (COMPLETED, FAILED, CANCELLED or TIMED_OUT).