POST
/
jobs
/
automated
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const automated = await client.jobs.automated.create({ type: 'data_sync_all' });

console.log(automated.job_id);
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_url": "https://api.tryfinch.com/jobs/automated/453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "allowed_refreshes": 2,
  "remaining_refreshes": 1
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

​
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json
​
type
enum<string>
required

The type of job to start.

Available options:
data_sync_all

Response

Created

​
allowed_refreshes
integer
required

The number of allowed refreshes per hour (per hour, fixed window)

​
remaining_refreshes
integer
required

The number of remaining refreshes available (per hour, fixed window)

​
job_id
string<uuid>

The id of the job that has been created.

​
job_url
string

The url that can be used to retrieve the job status

​
retry_at
string

ISO 8601 timestamp indicating when to retry the request