POST
/
syncs
curl --request POST \
  --url https://api.withterminal.com/tsp/v1/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "days": 7
}'
{
  "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
  "status": "completed",
  "failureReason": "Reason for failure if sync status is 'failed'",
  "issues": [
    "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
  ],
  "startFrom": "2021-01-06T03:24:53.000Z",
  "requestedAt": "2021-01-06T03:24:53.000Z",
  "completedAt": "2021-01-06T03:24:53.000Z"
}

By default, Terminal will sync all connections where syncMode = automatic on a regular cadence. For customers that may not need a fleet’s data to be kept up to date and want to reduce their active tracked trucks, you can set syncMode = manual and invoke this endpoint when you want to sync data.

If you’re wondering if this is relevent to your use case then feel free to reach out and we’d be happy to assist.

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Body

application/json
startFrom
string

When to start syncing from. If startFrom is not provided, it will either sync from the last time a sync was requested or now if the connection has no sync history.

days
number

How many days of history to sync from now. Will be converted to a date and used in place of startFrom

Response

201 - application/json
id
string
required
status
enum<string>
required
Available options:
requested,
in_progress,
completed,
failed
failureReason
string

If the sync failed, this will contain the reason

issues
array

Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues to the expand parameter.

startFrom
string

The earliest records to sync for those based on time (ex: historical locations and stats)

requestedAt
string
required
completedAt
string