Enqueue a New Automated Job
Enqueue an automated job.
data_sync_all: Enqueue a job to re-sync all data for a connection. data_sync_all has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the job_id of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.
w4_form_employee_sync: Enqueues a job for sync W-4 data for a particular individual, identified by individual_id. This feature is currently in beta.
This endpoint is available for Scale tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.
Currently, only the data_sync_all job type is supported, which will enqueue a job to re-sync all data for a connection. data_sync_all has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the job_id of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.
This endpoint is available for Scale tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
Body
The type of job to start.
data_sync_all Response
The id of the job that has been created.
The url that can be used to retrieve the job status
The number of allowed refreshes per hour (per hour, fixed window)
The number of remaining refreshes available (per hour, fixed window)
Was this page helpful?