Cancel a job

curl -X POST https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID/cancel \
     -H "X-Disable-Hooks: true" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "info": "Job was canceled"
}'

{
  "data": {
    "createdAt": "2023-10-30T20:04:28.556Z",
    "createdBy": "us_usr_YOUR_ID",
    "id": "us_jb_YOUR_ID",
    "operation": "submitAction",
    "source": "us_wb_YOUR_ID",
    "type": "workbook",
    "updatedAt": "2023-10-30T20:04:32.075Z",
    "config": {},
    "destination": "us_wb_YOUR_ID",
    "environmentId": "us_env_YOUR_ID",
    "fileId": "us_fl_YOUR_ID",
    "finishedAt": "2023-10-30T20:04:32.074Z",
    "info": "Starting job to submit action to webhook.site",
    "input": {},
    "managed": true,
    "mode": "foreground",
    "outcome": {
      "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
    },
    "progress": 100,
    "spaceId": "us_sp_YOUR_ID",
    "startedAt": "2023-10-30T20:04:29.453Z",
    "status": "complete",
    "subject": {
      "type": "resource",
      "id": "us_wb_YOUR_ID"
    },
    "trigger": "immediate"
  }
}

Cancel a job and return the job

Authentication

AuthorizationBearer

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

Path parameters

jobIdstringRequired

ID of job to return

Request

This endpoint expects an optional object.

infostringOptional

Response

This endpoint returns an object.

dataobject

A single unit of work that will execute asynchronously

Authentication

Path parameters

Headers

Request

Response

Authentication

Path parameters

Headers

Request

Response