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 '
{
"options": {},
"company": {
"name": "Acme Inc.",
"dotNumbers": [
"<string>"
]
},
"externalId": "<string>",
"syncMode": "automatic",
"tags": [
"<string>"
],
"filters": {
"vehicles": {
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
}
}
'import requests
url = "https://api.withterminal.com/tsp/v1/connections/current"
payload = {
"options": {},
"company": {
"name": "Acme Inc.",
"dotNumbers": ["<string>"]
},
"externalId": "<string>",
"syncMode": "automatic",
"tags": ["<string>"],
"filters": {
"vehicles": {
"excludeIds": ["vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"],
"includeIds": ["vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"]
},
"drivers": {
"excludeIds": ["drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"],
"includeIds": ["drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"]
}
}
}
headers = {
"Connection-Token": "<connection-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Connection-Token': '<connection-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
options: {},
company: {name: 'Acme Inc.', dotNumbers: ['<string>']},
externalId: '<string>',
syncMode: 'automatic',
tags: ['<string>'],
filters: {
vehicles: {
excludeIds: ['vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'],
includeIds: ['vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC']
},
drivers: {
excludeIds: ['drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'],
includeIds: ['drv_01D8ZQFGHVJ858NBF2Q7DV9MNC']
}
}
})
};
fetch('https://api.withterminal.com/tsp/v1/connections/current', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withterminal.com/tsp/v1/connections/current",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'options' => [
],
'company' => [
'name' => 'Acme Inc.',
'dotNumbers' => [
'<string>'
]
],
'externalId' => '<string>',
'syncMode' => 'automatic',
'tags' => [
'<string>'
],
'filters' => [
'vehicles' => [
'excludeIds' => [
'vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'
],
'includeIds' => [
'vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'
]
],
'drivers' => [
'excludeIds' => [
'drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'
],
'includeIds' => [
'drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Connection-Token: <connection-token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withterminal.com/tsp/v1/connections/current"
payload := strings.NewReader("{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Connection-Token", "<connection-token>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withterminal.com/tsp/v1/connections/current")
.header("Connection-Token", "<connection-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withterminal.com/tsp/v1/connections/current")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Connection-Token"] = '<connection-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"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": "john.doe@example.com"
}
},
"provider": {
"code": "geotab",
"name": "Geotab"
},
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"createdAt": "2021-01-06T03:24:53.000Z",
"updatedAt": "2021-01-06T03:24:53.000Z",
"options": {},
"linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
"externalId": "1234",
"sourceId": "123456789",
"tags": [
"Tag Name"
],
"filters": {
"vehicles": {
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
}
}{
"code": "bad_request",
"message": "Invalid request body",
"detail": [
{
"message": "'vehicleId' property must be a valid ulid",
"path": "{requestQuery}.vehicleId",
"suggestion": "Please ensure you submit a valid 'vehicleId' property",
"context": {}
}
]
}{
"code": "unauthorized",
"message": "Unauthorized Request",
"detail": "Please ensure you have a valid API key"
}{
"code": "forbidden",
"message": "Forbidden Request",
"detail": "Please ensure the connection token matches the resource you are attempting to access."
}{
"code": "connection_disconnected",
"message": "Connection must be connected to perform this action",
"detail": []
}{
"code": "too_many_requests",
"message": "Too Many Requests",
"retryAfter": 60,
"detail": "You have exceeded your rate limit. Please try again later."
}{
"code": "internal_server_error",
"message": "Internal Server Error",
"detail": "Something went wrong"
}{
"code": "gateway_timeout",
"message": "Gateway Timeout"
}Connections
Update Current Connection
Update the details of the current active connection. The current connection is derived from the provided connection token.
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 '
{
"options": {},
"company": {
"name": "Acme Inc.",
"dotNumbers": [
"<string>"
]
},
"externalId": "<string>",
"syncMode": "automatic",
"tags": [
"<string>"
],
"filters": {
"vehicles": {
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
}
}
'import requests
url = "https://api.withterminal.com/tsp/v1/connections/current"
payload = {
"options": {},
"company": {
"name": "Acme Inc.",
"dotNumbers": ["<string>"]
},
"externalId": "<string>",
"syncMode": "automatic",
"tags": ["<string>"],
"filters": {
"vehicles": {
"excludeIds": ["vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"],
"includeIds": ["vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"]
},
"drivers": {
"excludeIds": ["drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"],
"includeIds": ["drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"]
}
}
}
headers = {
"Connection-Token": "<connection-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Connection-Token': '<connection-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
options: {},
company: {name: 'Acme Inc.', dotNumbers: ['<string>']},
externalId: '<string>',
syncMode: 'automatic',
tags: ['<string>'],
filters: {
vehicles: {
excludeIds: ['vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'],
includeIds: ['vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC']
},
drivers: {
excludeIds: ['drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'],
includeIds: ['drv_01D8ZQFGHVJ858NBF2Q7DV9MNC']
}
}
})
};
fetch('https://api.withterminal.com/tsp/v1/connections/current', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withterminal.com/tsp/v1/connections/current",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'options' => [
],
'company' => [
'name' => 'Acme Inc.',
'dotNumbers' => [
'<string>'
]
],
'externalId' => '<string>',
'syncMode' => 'automatic',
'tags' => [
'<string>'
],
'filters' => [
'vehicles' => [
'excludeIds' => [
'vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'
],
'includeIds' => [
'vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC'
]
],
'drivers' => [
'excludeIds' => [
'drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'
],
'includeIds' => [
'drv_01D8ZQFGHVJ858NBF2Q7DV9MNC'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Connection-Token: <connection-token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withterminal.com/tsp/v1/connections/current"
payload := strings.NewReader("{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Connection-Token", "<connection-token>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.withterminal.com/tsp/v1/connections/current")
.header("Connection-Token", "<connection-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withterminal.com/tsp/v1/connections/current")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Connection-Token"] = '<connection-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"options\": {},\n \"company\": {\n \"name\": \"Acme Inc.\",\n \"dotNumbers\": [\n \"<string>\"\n ]\n },\n \"externalId\": \"<string>\",\n \"syncMode\": \"automatic\",\n \"tags\": [\n \"<string>\"\n ],\n \"filters\": {\n \"vehicles\": {\n \"excludeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n },\n \"drivers\": {\n \"excludeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ],\n \"includeIds\": [\n \"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"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": "john.doe@example.com"
}
},
"provider": {
"code": "geotab",
"name": "Geotab"
},
"syncMode": "automatic",
"token": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4",
"createdAt": "2021-01-06T03:24:53.000Z",
"updatedAt": "2021-01-06T03:24:53.000Z",
"options": {},
"linkUrl": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}",
"externalId": "1234",
"sourceId": "123456789",
"tags": [
"Tag Name"
],
"filters": {
"vehicles": {
"excludeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
},
"drivers": {
"excludeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
],
"includeIds": [
"drv_01D8ZQFGHVJ858NBF2Q7DV9MNC"
]
}
}
}{
"code": "bad_request",
"message": "Invalid request body",
"detail": [
{
"message": "'vehicleId' property must be a valid ulid",
"path": "{requestQuery}.vehicleId",
"suggestion": "Please ensure you submit a valid 'vehicleId' property",
"context": {}
}
]
}{
"code": "unauthorized",
"message": "Unauthorized Request",
"detail": "Please ensure you have a valid API key"
}{
"code": "forbidden",
"message": "Forbidden Request",
"detail": "Please ensure the connection token matches the resource you are attempting to access."
}{
"code": "connection_disconnected",
"message": "Connection must be connected to perform this action",
"detail": []
}{
"code": "too_many_requests",
"message": "Too Many Requests",
"retryAfter": 60,
"detail": "You have exceeded your rate limit. Please try again later."
}{
"code": "internal_server_error",
"message": "Internal Server Error",
"detail": "Something went wrong"
}{
"code": "gateway_timeout",
"message": "Gateway Timeout"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The token returned when a user authenticated their account. This authorizes access to a specific account.
Pattern:
^con_tkn_\S+$Example:
"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"
Body
application/json
Available options:
connected, archived, disconnected Show child attributes
Show child attributes
Enum values:
automatic: Terminal will keep this connections data up to datemanual: Terminal will only sync data upon request
Available options:
automatic, manual Tags associated with the connection
Filters applied to connection data
Show child attributes
Show child attributes
Response
OK
- Full Connection
- Deleted Connection
The connection your application has with your customer's TSP.
Example:
"conn_01GV12VR4DJP70GD1ZBK0SDWFH"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enum values:
automatic: Terminal will keep this connections data up to datemanual: Terminal will only sync data upon request
Available options:
automatic, manual This token is used when interacting with a connections' data.
Pattern:
^con_tkn_\S+$Example:
"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"
The current status of the connection.
Available options:
connected, disconnected, archived, pending_deletion The URL to send your user to in order to have them re-authenticate the connection.
Example:
"https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}"
An optional ID from your system that can be used to reference connections.
Example:
"1234"
The ID used in the source system to represent the account this connection has or had access to.
This may be an organizationId or accountId.
Note: not all systems expose this information, in which case it may be undefined.
Example:
"123456789"
An optional list of tags from your system that can be used to reference connections.
Filters applied to connection data
Show child attributes
Show child attributes
⌘I