Skip to main content
PATCH
/
connections
/
current
Update Current Connection
curl --request PATCH \
  --url https://api.withterminal.com/tsp/v1/connections/current \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "connected",
  "options": {
    "ingestHistoryFromSourceSystem": true
  },
  "company": {
    "name": "Acme Inc.",
    "dotNumbers": [
      "<string>"
    ]
  },
  "externalId": "<string>",
  "syncMode": "automatic",
  "tags": [
    "<string>"
  ],
  "filters": {
    "vehicles": {
      "status": "active",
      "excludeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    },
    "drivers": {
      "status": "active",
      "excludeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    }
  }
}'
{
  "id": "conn_01GV12VR4DJP70GD1ZBK0SDWFH",
  "company": {
    "name": "Frank's Trucking",
    "dotNumbers": [
      "1234567"
    ]
  },
  "account": {
    "name": "Frank's Trucking",
    "dotNumbers": [
      "1234567"
    ],
    "user": {
      "sourceId": "1234567",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]"
    }
  },
  "status": "connected",
  "provider": {
    "code": "geotab",
    "name": "Geotab"
  },
  "externalId": "1234",
  "sourceId": "123456789",
  "syncMode": "automatic",
  "token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
  "tags": [
    "Tag Name"
  ],
  "options": {
    "ingestHistoryFromSourceSystem": true
  },
  "filters": {
    "vehicles": {
      "status": "active",
      "excludeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    },
    "drivers": {
      "status": "active",
      "excludeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "includeIds": [
        "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ]
    }
  },
  "linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
  "createdAt": "2021-01-06T03:24:53.000Z",
  "updatedAt": "2021-01-06T03:24:53.000Z"
}

Authorizations

Authorization
string
header
required

Headers

Connection-Token
string
required
Example:

Body

application/json
status
enum<string>
Available options:
connected,
archived,
disconnected
options
object
  • Omnitracs Options
  • Omnitracs ES Options
  • Omnitracs XRS Options
company
object
externalId
string
syncMode
enum<string>
default:automatic
Available options:
automatic,
manual
tags
string[]
filters
object

Response

id
string<ulid>
required
Example:
company
object
required
account
object
required
status
enum<string>
required
Available options:
connected,
disconnected,
archived,
pending_deletion
provider
object
required
syncMode
enum<string>
default:automatic
required
Available options:
automatic,
manual
token
string
required
Example:
options
object
required
  • Omnitracs Options
  • Omnitracs ES Options
  • Omnitracs XRS Options
Example:
createdAt
string<date-time>
required
Example:
updatedAt
string<date-time>
required
Example:
externalId
string
Example:
sourceId
string
Example:
tags
string[]
filters
object