Update a job (API Explorer) | Flatfile

Accounts
- GETGet the current account
- PATCHUpdate the current account
Actions
- POSTCreate an action
- POSTCreate several actions
- GETGet all actions for the space
- GETGet an action
- PATCHUpdate an action
- DELDelete an action
Agent Exports
- GETList agent exports
- GETGet an agent export
- GETDownload an agent export
- DELDelete an agent export
Agents
- GETList agents
- POSTCreate an agent
- GETGet an agent
- GETList agent versions for an agent
- GETRevert to a specific agent version
- GETList Agent Roles
- POSTAssign Role to Agent
- DELRemove Role from Agent
- GETGet logs for an agent
- GETGet an agent log
- GETGet all agent logs in your environment
- GETGet all executions in your environment
- DELDelete an agent
Apps
- GETList apps
- GETGet an app
- PATCHUpdate an app
- POSTCreate an app
- DELDelete an app
- GETGet constraints
- POSTCreate constraint
- GETGet constraint by ID
- GETGet constraint versions
- GETGet constraint version
- PATCHUpdate constraint
- DELDelete constraint
Assistant
- GETList prompts
- GETGet a prompt
- PATCHUpdate a prompt
- POSTCreate a prompt
- DELDelete a prompts
Auth
- GETGet SFTP credentials for Space
Canvas Areas
- GETList canvas areas
- POSTCreate a canvas area
- GETGet a canvas area
- PATCHUpdate a canvas area
- DELDelete a canvas area
Commits
- GETGet a commit version
- POSTComplete a commit version
- POSTReplay a commit version
Data Retention Policies
- GETList data retention policies
- POSTCreate a data retention policy
- GETGet a data retention policy
- PATCHUpdate a data retention policy
- DELDelete a data retention policy
Documents
- GETList documents
- POSTCreate a document
- GETGet a document
- PATCHUpdate a document
- DELDelete a document
Entitlements
- GETList entitlements
Environments
- GETList environments
- POSTCreate an environment
- GETGet environment subscription credentials
- GETGet an environment
- PATCHUpdate an environment
- DELDelete an environment
- GETList guides
- GETGet a guide
- PATCHUpdate a guide
- POSTCreate a guide
- DELDelete a guide
- GETGet guide version
Events
- GETList events
- POSTCreate an event
- GETGet an event
- POSTAcknowledge an event
- GETGet subscription credentials
Files
- GETList files
- POSTUpload a file
- GETGet a file
- DELDelete a file
- PATCHUpdate a file
- GETDownload a file
Guests
- GETList guests
- POSTCreate a guest
- GETGet a guest
- DELDelete a guest
- PATCHUpdate a guest
- GETGet guest token
- GETList Guest Roles
- POSTAssign Role to Guest
- DELRemove Role from Guest
- POSTInvite guests
Jobs
- GETList jobs
- POSTCreate a job
- GETGet a job
- PATCHUpdate a job
- DELDelete a job
- POSTExecute a job
- GETGet a job's execution plan
- PUTReplace a job's plan
- PATCHUpdate a job's plan
- POSTAcknowledge a job
- POSTAcknowledge a job outcome
- POSTComplete a job
- POSTFail a job
- POSTCancel a job
- POSTRetry a failed job
- POSTPreview a mutation
- POSTSplit a job
Mapping
- POSTCreate a mapping between two schemas
- DELDelete all history for the authenticated user
- GETList mapping programs
- GETGet a mapping program
- PATCHUpdate a mapping program
- DELDelete a mapping program
- POSTAdd mapping rules to a program
- DELDelete multiple mapping rules
- GETList mapping rules
- GETGet a mapping rule
- PATCHUpdate a mapping rule
- PATCHUpdate a list of mapping rules
- DELDelete a mapping rule
Records
- GETGet records
- GETGet record Indices
- PUTUpdate records
- POSTInsert records
- DELDelete records
- PUTFinds and replaces field values matching search criteria
Roles
- GETList roles
Routines
- GETList routines
- GETGet a routine
- POSTCreate a routine
- PATCHUpdate a routine
- DELDelete a routine
Runbooks
- GETList runbooks
- GETGet a runbook
- POSTCreate a runbook
- PATCHUpdate a runbook
- DELDelete a runbook
Secrets
- GETList secrets
- POSTUpsert a Secret
- DELDelete a secret by it's Id
Sheets
- GETList sheets
- GETGet a sheet
- DELDelete a sheet
- POSTValidate a sheet
- GETDownload records as a CSV file
- GETGet record counts
- GETList calculations
- GETGet commit versions for a sheet
- POSTLock a sheet
- POSTUnlock a sheet
- GETGet record cells by field
- PATCHUpdate a sheet
Snapshots
- POSTCreate a snapshot
- GETList snapshots
- GETGet a snapshot
- DELDelete a snapshot
- POSTRestore a snapshot
- GETGet records from a snapshot
Spaces
- GETList spaces
- POSTCreate a space
- GETGet a space
- DELDelete a space
- DELDelete spaces
- PATCHUpdate a space
- POSTArchives a space
- POSTUnarchives a space
- POSTCreate a new guidance
- GETList guidances
- GETGet a guidance
- PATCHUpdate a guidance
- DELDelete a guidance
Users
- GETList users
- POSTCreate and Invite User
- POSTResend User Invite
- PATCHUpdate a user
- GETGet a user
- DELDelete a user
- GETList User Roles
- POSTAssign Role to User
- DELRemove Role from User
Versions
- POSTCreate Id
Views
- GETList views by Sheet
- POSTCreate a view
- GETGet a view
- PATCHUpdate a view
- DELDelete a view
Workbooks
- GETList workbooks
- POSTCreate a workbook
- GETGet a workbook
- DELDelete a workbook
- PATCHUpdate a workbook
- GETGet commits for a workbook

Built with

PATCHhttps://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID

Headers

X-Disable-Hooks"true"Required
true

Path Parameters

jobIdstringRequired

Body Parameters

configobject
sheetstringRequired
statusenum
progressinteger

View in API Reference

Request

$ curl -X PATCH https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID \
>      -H "Authorization: Bearer " \
>      -H "X-Disable-Hooks: true" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "config": {},
>   "status": "complete",
>   "progress": 100
> }'

Response

$	curl -X PATCH https://api.x.flatfile.com/v1/jobs/us_jb_YOUR_ID \
>	-H "Authorization: Bearer " \
>	-H "X-Disable-Hooks: true" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"config": {},
>	"status": "complete",
>	"progress": 100
>	}'