Endpoint
POST https://plainly.com/stop
Parameters
task |
Required. Key of the relevant task being stopped. Can be obtained via the {{checklist_key}} variable.
|
key |
Required. Workflow-specific API key. Obtained from the Developer tab for the relevant workflow in the Toolkit.
|
comment |
Optional. Your reason why the task was stopped.
|
restart |
Optional. If true, will restart a stopped task. NOTE: If the task was automatically stopped via a kill action, the task cannot be restarted.
|
Example
Request
https://plainly.com/stop
On success
{
"data": {
"status": 200,
"title": "Task stopped",
"detail": "Customer no longer wishes to proceed."
}
}
On error
{
"errors": [
{
"status": 400,
"title": "Missing attribute",
"detail": "You need task and key parameters."
}
]
}
Endpoint