Update odometer (V2)
curl --request PUT \
--url https://api.telemax.com.au/v2/api/vehicles/{id}/odometer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/v2/api/vehicles/{id}/odometer"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/v2/api/vehicles/{id}/odometer', 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.telemax.com.au/v2/api/vehicles/{id}/odometer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.telemax.com.au/v2/api/vehicles/{id}/odometer"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.telemax.com.au/v2/api/vehicles/{id}/odometer")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/v2/api/vehicles/{id}/odometer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{}{
"type": "AUTHENTICATION",
"code": "INVALID_CREDENTIALS",
"description": "The provided API key is invalid or does not exist.",
"requestId": "0HNLTALNU4DCO:00000004",
"docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}{
"type": "AUTHORIZATION",
"code": "INVALID_SCOPE",
"description": "The provided token does not have permission to access this resource.",
"requestId": "50e5c5f7-ccae-4ab6-b070-56d6645ceb1e",
"docUrl": "https://docs.telemax.com.au/errors/invalid-scope"
}{
"type": "RESOURCE",
"code": "NOT_FOUND",
"description": "Vehicle was not found.",
"requestId": "0HNLTALNU4DDI:00000002",
"docUrl": "https://docs.telemax.com.au/errors/not-found"
}{
"type": "RESOURCE_CONFLICT",
"code": "ODOMETER_SOURCE_CONFLICT",
"description": "The vehicle's odometer is provided by the CAN bus and cannot be manually updated.",
"docUrl": "https://docs.telemax.com.au/errors/odometer-source-conflict"
}{
"type": "VALIDATION_ERROR",
"code": "INVALID_INPUT",
"description": "Odometer value must be greater than or equal to zero.",
"requestId": "0HNLTALNU4DDH:00000002",
"docUrl": "https://docs.telemax.com.au/errors/invalid-input"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Please slow down.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_SERVER_ERROR",
"description": "An unexpected error occurred. Please try again later.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}Vehicle commands
Update odometer
Sets the GPS odometer reading for a vehicle.
PUT
/
v2
/
api
/
vehicles
/
{id}
/
odometer
Update odometer (V2)
curl --request PUT \
--url https://api.telemax.com.au/v2/api/vehicles/{id}/odometer \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/v2/api/vehicles/{id}/odometer"
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/v2/api/vehicles/{id}/odometer', 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.telemax.com.au/v2/api/vehicles/{id}/odometer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.telemax.com.au/v2/api/vehicles/{id}/odometer"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.telemax.com.au/v2/api/vehicles/{id}/odometer")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/v2/api/vehicles/{id}/odometer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{}{
"type": "AUTHENTICATION",
"code": "INVALID_CREDENTIALS",
"description": "The provided API key is invalid or does not exist.",
"requestId": "0HNLTALNU4DCO:00000004",
"docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}{
"type": "AUTHORIZATION",
"code": "INVALID_SCOPE",
"description": "The provided token does not have permission to access this resource.",
"requestId": "50e5c5f7-ccae-4ab6-b070-56d6645ceb1e",
"docUrl": "https://docs.telemax.com.au/errors/invalid-scope"
}{
"type": "RESOURCE",
"code": "NOT_FOUND",
"description": "Vehicle was not found.",
"requestId": "0HNLTALNU4DDI:00000002",
"docUrl": "https://docs.telemax.com.au/errors/not-found"
}{
"type": "RESOURCE_CONFLICT",
"code": "ODOMETER_SOURCE_CONFLICT",
"description": "The vehicle's odometer is provided by the CAN bus and cannot be manually updated.",
"docUrl": "https://docs.telemax.com.au/errors/odometer-source-conflict"
}{
"type": "VALIDATION_ERROR",
"code": "INVALID_INPUT",
"description": "Odometer value must be greater than or equal to zero.",
"requestId": "0HNLTALNU4DDH:00000002",
"docUrl": "https://docs.telemax.com.au/errors/invalid-input"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Please slow down.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_SERVER_ERROR",
"description": "An unexpected error occurred. Please try again later.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}Overview
Updates the GPS odometer value for the specified vehicle.The V1 version of this endpoint is Change odometer.
Rate limit: 10 req/s · 30/min · 6,000/hr · 144,000/day
Endpoint
PUT /v2/api/vehicles/{id}/odometer
Path parameters
integer
required
Vehicle ID.
Query parameters
number
required
New odometer value in kilometres.
Response
200 OK — empty body. The odometer was updated successfully.Error responses
| Status | Meaning |
|---|---|
| 401 | Token does not have access to this vehicle |
| 404 | Vehicle not found |
| 422 | Invalid odometer value (e.g. negative number) |
curl -X PUT "https://api.telemax.com.au/v2/api/vehicles/88421/odometer?odometer=154200" \
-H "Authorization: Bearer <token>"
Authorizations
JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.
Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.
Scoping: API key tokens are scoped to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).
No refresh endpoint — re-authenticate with your API key when the token expires.
Path Parameters
Query Parameters
New odometer value in kilometres. Must be ≥ 0. Defaults to 0 if omitted.
Required range:
x >= 0Response
200 OK — Empty body. Odometer updated successfully.
Was this page helpful?
⌘I