Skip to main content
POST
/
dispatch
/
tasks
/
{task_id}
/
cancel
Cancel a task
curl --request POST \
  --url https://api.parse.bot/dispatch/tasks/{task_id}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "task_id": "<string>",
  "previous_status": "<string>",
  "cancelled": true
}

Authorizations

X-API-Key
string
header
required

API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

Path Parameters

task_id
string
required

Response

Cancellation result

task_id
string
previous_status
string
cancelled
boolean