Skip to main content
POST
Request cooperative job cancellation

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained until key deletion. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

task_id
string<uuid>
required

Body

application/json
reason
string
default:API key requested cancellation
Required string length: 1 - 255

Response

OK

task_id
string
required
task_type
string
required
status
string
required
stage
string | null
required
total_items
integer
required
processed_items
integer
required
successful_items
integer
required
failed_items
integer
required
skipped_items
integer
required
progress_percentage
number
required
cancellation_requested
boolean
required
started_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
finished_at
string<date-time> | null
required