Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Response

Sync job started.

status
enum<string>
required
Available options:
queued,
running,
idle
start_timestamp
number

Epoch milliseconds when the job started.

succeeded
number

Number of items processed successfully so far.

failed
number

Number of items that errored so far.

triggered_by
enum<string>

Whether the job was started by an explicit API call (manual) or by the scheduled sync (cron).

Available options:
manual,
cron