Update a job

PATCH

Path parameters

jobIdstringRequired

The id of the job to patch

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

configobjectOptional

statusenumOptional

the status of the job

progressintegerOptional

the progress of the job. Whole number between 0 and 100

outcomeAcknowledgedAtdatetimeOptional

the time that the job’s outcome has been acknowledged by a user

infostringOptional

Current status of job in text

metadatamap from strings to anyOptional

Additional metadata for the job

Response

This endpoint returns an object.

dataobject

A single unit of work that will execute asynchronously

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "config": {},
7   "status": "complete",
8   "progress": 100
9 }'

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 }

Built with

1	curl -X PATCH https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"config": {},
7	"status": "complete",
8	"progress": 100
9	}'

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	}