Cancel a job

POST

https://api.x.flatfile.com/v1/jobs/:jobId/cancel

POST

/v1/jobs/:jobId/cancel

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

Try it

200Example0

1 {
2   "data": {
3     "createdAt": "2023-10-30T20:04:28.556Z",
4     "createdBy": "us_usr_YOUR_ID",
5     "id": "us_jb_YOUR_ID",
6     "operation": "submitAction",
7     "source": "us_wb_YOUR_ID",
8     "type": "workbook",
9     "updatedAt": "2023-10-30T20:04:32.075Z",
10     "config": {},
11     "destination": "us_wb_YOUR_ID",
12     "environmentId": "us_env_YOUR_ID",
13     "fileId": "us_fl_YOUR_ID",
14     "finishedAt": "2023-10-30T20:04:32.074Z",
15     "info": "Starting job to submit action to webhook.site",
16     "input": {},
17     "managed": true,
18     "mode": "foreground",
19     "outcome": {
20       "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
21     },
22     "progress": 100,
23     "startedAt": "2023-10-30T20:04:29.453Z",
24     "status": "complete",
25     "subject": {
26       "type": "resource",
27       "id": "us_wb_YOUR_ID"
28     },
29     "trigger": "immediate"
30   }
31 }

Cancel a job and return the job

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

Path parameters

Headers

Request

Response