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

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

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

  console.log(automated.job_id);
}

main();
{
  "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
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

type
enum<string>
required

The type of job to start.

Available options:
data_sync_all

Response

201
application/json
Created
job_id
string

The id of the job that has been created.

job_url
string

The url that can be used to retrieve the job status

allowed_refreshes
integer

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

remaining_refreshes
integer

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