Skip to content
BuildWorkPro Docs

Cancel job

POST
/jobs/{id}/cancel

Cancels a queued or running job. Already-terminal jobs return 409.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Cancelled

object
data
required
object
id
required
string
type
required
string
resourceType
required
string
status
required
string
progress
object
processed
required
integer
total
required
integer
errorsCount
required
integer
params
result
errorMessage
string | null
createdAt
required
Any of:
string format: date-time
startedAt
Any of:
string format: date-time
completedAt
Any of:
string format: date-time
expiresAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

404

Section titled “404 ”

Not found

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string

409

Section titled “409 ”

Job already terminal

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string