Skip to main content
POST
/
v2
/
telematics
/
vehicles
Create Vehicle
curl --request POST \
  --url https://api.catenatelematics.com/v2/telematics/vehicles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Provisional endpoint
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

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Vehicle model for creating new records

​
connection_id
string<uuid>
required

Unique identifier of the connection at Catena Telematics which will be used to create this resource. A connection represents a Fleet/TSP pairing.

​
fleet_ref
string | null

External fleet reference in the partner system.

​
vehicle_name
string | null

Display name or unit number for the vehicle.

​
oem
string | null

Manufacturer (OEM) of the vehicle.

​
model_type
string | null

Manufacturer model or type designation (e.g., 'Class 8 Tractor', 'Pickup').

​
model_year
integer | null

Model year (four-digit, e.g., 2022).

​
vin
string | null

Vehicle Identification Number (VIN), typically 17 characters; if available.

​
engine_vin
string | null

Engine serial number or engine VIN, if available.

​
license_plate_region
string | null

Plate region/subdivision (state/province code, e.g., 'CA', 'ON').

​
license_plate_country
string | null

Plate country code (ISO-3166-1 alpha-3, e.g., 'USA', 'CAN').

Pattern: ^\w{3}$
​
license_plate_number
string | null

License plate number (e.g., 'HMT-3570').

​
is_active
boolean | null

Indicates whether the vehicle is currently active/in service.

​
status
enum<string> | null

Operational status label (e.g., 'IN_SERVICE', 'OUT_OF_SERVICE', 'MAINTENANCE').

Available options:
IN_SERVICE,
OUT_OF_SERVICE,
IN_REPAIR,
IN_TRANSIT,
IN_USE,
IN_STORAGE,
STANDING,
SPARE
​
notes
string | null

Free-text notes about the vehicle (plain text).

​
eld_id
string | null

Telematics/ELD device identifier associated with this vehicle, if any.

​
eld_serial_number
string | null

Telematics/ELD device serial number, if any.

​
eld_device_type
string | null

Telematics/ELD device type or model family (vendor-specific).

​
eld_product_id
string | null

Telematics/ELD vendor product identifier (catalog/model code).

​
total_axles
integer | null

Total number of axles on the vehicle.

​
external_id
string | null

External vehicle identifier as known in the TSP or customer's system.

​
speed_unit
string | null

Unit of measure for speed metrics (e.g., 'km/h', 'mph').

​
odometer_unit
string | null

Unit of measure for odometer readings (e.g., 'km', 'mi').

​
fuel_unit
string | null

Unit of measure for fuel quantities (e.g., 'gallons', 'liters').

​
fuel_capacity
string | null

Fuel capacity as provided by the source (text with units, e.g., '100 gallons').

​
engine_type
enum<string> | null

Engine/fuel type (e.g., 'diesel', 'gasoline', 'electric', 'hybrid').

Available options:
GASOLINE,
GASOLINE,
GASOLINE,
DIESEL,
DIESEL,
DIESEL,
ETHANOL,
ETHANOL,
ETHANOL,
METHANOL,
METHANOL,
PROPANE,
LPG,
CNG,
LNG,
HYDROGEN,
ELECTRICITY,
HYBRID

Response

The request to create the vehicle has been accepted and is being processed.

Resource operation model for API responses

​
id
string<uuid>
required

Unique identifier for the resource operation.