Skip to main content

Pull Tracking Updates from 17TRACK

POST 

/api/integrations/17track/instances/:instance/refresh

Queue an immediate sync from 17TRACK — the same run as the scheduled poll that happens every 6 hours. It re-fetches the latest status for every active tracking that has been registered with 17TRACK, is not yet in a final state and whose last carrier event is older than 12 hours (or that has no event yet), in batches of 40, updates those trackings, and stamps the instance's last poll time.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

The sync runs in the background: the response returns data.tracked_job_log_id, the background job to follow for progress and the result. Nothing is fetched when inbound tracking sync is turned off in the instance's sync settings (the job completes as skipped).

Activity log: records manual_refresh_triggered (with the acting user), then poll_completed with the number of trackings updated.

Responses:

  • 200 OK — sync queued
  • 403 Forbidden — missing the integrations.sync permission
  • 404 Not Found — instance id does not exist

Requires the integrations.sync permission.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type