Skip to main content
PUT
Update odometer (V2)

Overview

Sends a new GPS odometer value to the vehicle’s device as a command.
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
Public vehicle ID (deviceId).

Query parameters

number
New odometer value in kilometres. Optional, but always send it — see the warning below.
Omitting odometer sets the vehicle’s odometer to 0.

Response

200 OK — empty body. Returned even when the command could not be sent to the device, so it does not confirm that the device received or applied the value; Last position changes once the device reports the new odometer.

Error responses

Authorizations

Authorization
string
header
required

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 by the key's company and its action set; see Token scoping.

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

id
integer
required

Query Parameters

odometer
number

New odometer value in kilometres. Must be ≥ 0. Omitting it sets the odometer to 0 — always send it.

Required range: x >= 0

Response

200 OK — Empty body. Returned even when the command could not be sent to the device; it does not confirm that the device received or applied the value.