Skip to main content
PUT
/
api
/
v2
/
vehicles
/
{id}
/
odometer
/
source
Update odometer source (V2)
curl --request PUT \
  --url https://api.telemax.com.au/api/v2/vehicles/{id}/odometer/source \
  --header 'Authorization: Bearer <token>'
{}

Overview

Switches the active odometer source between CAN (vehicle CAN bus) and GPS (GNSS-derived). Returns 409 if the device does not support the requested source.
Rate limit: 30 requests per 60 seconds per token.

Endpoint

PUT /api/v2/vehicles/{id}/odometer/source

Path parameters

id
integer
required
Legacy vehicle ID.

Query parameters

source
string
required
Desired odometer source. Must be CAN or GPS (case-insensitive).

Response

200 OK — empty body. Odometer source updated successfully.

Error responses

StatusMeaning
401Missing or invalid token
403Token does not have permission to access this vehicle
404Vehicle not found
409Device does not support the requested odometer source
422source is missing or not CAN/GPS
409 response body:
{
  "type": "RESOURCE_CONFLICT",
  "code": "ODOMETER_SOURCE_NOT_SUPPORTED",
  "description": "The device does not support the specified value as a valid odometer source.",
  "docUrl": "https://docs.telemax.com.au/errors/odometer-source-unsupported"
}
curl -X PUT "https://api.telemax.com.au/api/v2/vehicles/88421/odometer/source?source=GPS" \
  -H "Authorization: Bearer <token>"

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /api/v2/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

id
integer
required

Query Parameters

source
enum<string>
required

Desired odometer source. Must be CAN or GPS (case-insensitive).

Available options:
CAN,
GPS

Response

200 OK — Empty body. Odometer source updated successfully.