Cancel job - SmartlyQ

POST

jobs

{job_id}

cancel

Cancel job

curl --request POST \
  --url https://api.smartlyq.com/v1/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "success": true,
  "data": {
    "id": "<string>",
    "type": "<string>",
    "result": {},
    "error": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

API key from Developer dashboard (Bearer token).

Path Parameters

job_id

string

required

Body

application/json

The body is of type object.

Response

Job cancelled

success

enum<boolean>

Available options:

true

data

object

Show child attributes

meta

object

Show child attributes

List webhooksList the workspace's webhook subscriptions and the available event names. Requires scope `webhooks:read`.

Cancel job

curl --request POST \
  --url https://api.smartlyq.com/v1/jobs/{job_id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "success": true,
  "data": {
    "id": "<string>",
    "type": "<string>",
    "result": {},
    "error": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}