Skip to main content
POST
/
v1
/
jobs
/
{id}
/
cancel
Error
A valid request URL is required to generate request examples
{
  "id": "job_M4qT8YH7xW2pL9nB",
  "status": "<string>",
  "finished_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Request-Id
string

Optional client request ID. Echoed back on response.

​
Content-Type
string
required
Pattern: ^application/json(;.*)?$

Path Parameters

​
id
string
required
Pattern: ^job_[A-Za-z0-9_-]+$
Example:

"job_M4qT8YH7xW2pL9nB"

Body

application/json

The body is of type object.

Response

Job cancelled

​
id
string
required
Pattern: ^job_[A-Za-z0-9_-]+$
Example:

"job_M4qT8YH7xW2pL9nB"

​
status
string
required
Allowed value: "cancelled"
​
finished_at
string<date-time>
required