🧪 Update Vehicle
Update an existing vehicle. By default, the vehicle will be updated asynchronously, and you can check the status of the operation using the returned operation ID.
This endpoint is available for early access. The core schema is stable, but minor details — such as field names or added fields — may change before it becomes generally available. Backward compatibility is not guaranteed.
See API Stability & Versioning for details on provisional endpoints.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the vehicle
Query Parameters
Whether to process the request synchronously. If true, Catena will attempt to create or update the resource immediately with the TSP and return the result in the response. When performing synchronous operations, you are responsible for handling any necessary retries in case of transient failures.If false (default), Catena will create an asynchronous operation, and you can check the status of the operation using the returned operation ID.
Body
Vehicle model for updating existing records
Unique identifier of the connection at Catena Telematics which will be used to create this resource. A connection represents a Fleet/TSP pairing.
Display name or unit number for the vehicle.
Manufacturer (OEM) of the vehicle.
Manufacturer model or type designation (e.g., 'Class 8 Tractor', 'Pickup').
Model year (four-digit, e.g., 2022).
Vehicle Identification Number (VIN), typically 17 characters; if available.
Engine serial number or engine VIN, if available.
Plate region/subdivision (state/province code, e.g., 'CA', 'ON').
Plate country code (ISO-3166-1 alpha-3, e.g., 'USA', 'CAN').
^\w{3}$License plate number (e.g., 'HMT-3570').
Indicates whether the vehicle is currently active/in service.
Operational status label (e.g., 'IN_SERVICE', 'OUT_OF_SERVICE', 'MAINTENANCE').
IN_SERVICE, OUT_OF_SERVICE, IN_REPAIR, IN_TRANSIT, IN_USE, IN_STORAGE, STANDING, SPARE Free-text notes about the vehicle (plain text).
Telematics/ELD device identifier associated with this vehicle, if any.
Telematics/ELD device serial number, if any.
Telematics/ELD device type or model family (vendor-specific).
Telematics/ELD vendor product identifier (catalog/model code).
Total number of axles on the vehicle.
External vehicle identifier as known in the TSP or customer's system.
Unit of measure for speed metrics (e.g., 'km/h', 'mph').
Unit of measure for odometer readings (e.g., 'km', 'mi').
Unit of measure for fuel quantities (e.g., 'gallons', 'liters').
Fuel capacity as provided by the source (text with units, e.g., '100 gallons').
Engine/fuel type (e.g., 'diesel', 'gasoline', 'electric', 'hybrid').
GASOLINE, GASOLINE, GASOLINE, DIESEL, DIESEL, DIESEL, ETHANOL, ETHANOL, ETHANOL, METHANOL, METHANOL, PROPANE, LPG, CNG, LNG, HYDROGEN, ELECTRICITY, HYBRID Response
The vehicle was updated successfully.
Resource operation model
The ID of the partner that created the operation.
The ID of the connection
The type of resource to operate on (e.g., vehicle, driver).
asset, driver_association, driver_vehicle_association, driver_event_log, driver_safety_event, dvir_log, dvir_log_defect, engine_log, engine_status, fuel_transaction, fleet_info, hos_availability, hos_daily_snapshot, hos_event, hos_event_annotation, hos_event_attachment, hos_violation, ifta_summary, location_segment, message, group_message, user, vehicle, vehicle_location, vehicle_sensor, vehicle_region_segment, trailer, trailer_association, trailer_vehicle_association, trailer_location, trailer_status, workflow The type of operation to perform (e.g., create, update).
create, update The payload of the operation, containing the resource attributes to be created or updated.
Unique identifier for the resource operation.
Immutable: The datetime the record was created in Catena Telematics.
The datetime the record was last modified in Catena Telematics.
The datetime the record was logically deleted from Catena Telematics.
Unique identifier of the record. Can be null for create operations where the source does not exist yet.
The unique identifier of the resource in the source system. Required for update operations.
The status of the operation
pending, success, failed Log entries for each attempt to execute this operation.