Request Sync
Changed onManually request to sync the current connections data.
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.
Request
- Base URLhttps://api.withterminal.com/tsp/v1
- URLhttps://api.withterminal.com/tsp/v1/syncs
- AuthHTTP bearer
Headers
The token returned when a user authenticated their account. This authorizes access to a specific account.
Request body
Example request
{
"days": 7
}Response
Created
Example response
{
"id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
"status": "completed",
"failureReason": "Reason for failure if sync status is 'failed'",
"progress": 85,
"issues": [
"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"startFrom": "2021-01-06T03:24:53.000Z",
"requestedAt": "2021-01-06T03:24:53.000Z",
"completedAt": "2021-01-06T03:24:53.000Z",
"attempts": 1,
"providerRequests": [
"historical_files"
]
}Changes
- breaking
added to the
/response propertyoneOflist for the response status - warning
added the new
provider_timeoutenum value to theresponse property for the response status - info
added the non-success response with the status
- info
removed
subschema #2from the/response propertyoneOflist for the response status
- breaking