Cancel a job

POST

1 from flatfile import Flatfile
2 from flatfile.jobs import JobCancelDetails
3 
4 client = Flatfile(
5     token="YOUR_TOKEN",
6 )
7 client.jobs.cancel(
8     job_id="us_jb_YOUR_ID",
9     request=JobCancelDetails(
10         info="Job was canceled",
11     ),
12 )

Try it

200Example0

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

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