Skip to main content
POST
Create On-Demand Sync
On-demand syncs are only available for select integrations and functions. See Supported Functions for the current list. Requesting an unsupported integration + function combination returns a 400. For how on-demand syncs work end to end, see the On-Demand Syncs guide.

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Body

application/json
start_time
string<date-time>
required

The start time for the sync range.

Example:

"2023-03-15T13:45:30Z"

end_time
string<date-time>
required

The end time for the sync range.

Example:

"2023-03-15T13:45:30Z"

function_name
string
required

The function to sync.

Example:

"function_name"

Response

Successful response

data
SyncJob · object
required