🧪 Update Vehicle

Update Vehicle

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

import requests

url = "https://api.catenatelematics.com/v2/telematics/vehicles/{id}"

payload = { "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.catenatelematics.com/v2/telematics/vehicles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.catenatelematics.com/v2/telematics/vehicles/{id}"

	payload := strings.NewReader("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.catenatelematics.com/v2/telematics/vehicles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.patch("https://api.catenatelematics.com/v2/telematics/vehicles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.catenatelematics.com/v2/telematics/vehicles/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.catenatelematics.com/v2/telematics/vehicles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

{
  "code": 400,
  "message": "Bad Request",
  "detail": "<string>"
}

{
  "code": 401,
  "message": "Unauthorized",
  "detail": "<string>"
}

{
  "code": 403,
  "message": "Forbidden",
  "detail": "<string>"
}

{
  "code": 404,
  "message": "Not Found",
  "detail": "<string>"
}

{
  "code": 405,
  "message": "Method Not Allowed",
  "detail": "<string>"
}

{
  "code": 409,
  "message": "Conflict",
  "detail": "<string>"
}

{
  "code": 422,
  "message": "Invalid Request Body",
  "detail": [
    {
      "path": "<string>",
      "input": "<string>",
      "message": "<string>",
      "error_type": "<string>"
    }
  ]
}

{
  "code": 429,
  "message": "Too Many Requests",
  "detail": {
    "retry_after_seconds": 123,
    "message": "<string>"
  }
}

{
  "message": "Internal Server Error"
}

{
  "code": 501,
  "message": "Not Implemented",
  "detail": "<string>"
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

PATCH

telematics

vehicles

{id}

Update Vehicle

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

import requests

url = "https://api.catenatelematics.com/v2/telematics/vehicles/{id}"

payload = { "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.catenatelematics.com/v2/telematics/vehicles/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.catenatelematics.com/v2/telematics/vehicles/{id}"

	payload := strings.NewReader("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.catenatelematics.com/v2/telematics/vehicles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.patch("https://api.catenatelematics.com/v2/telematics/vehicles/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.catenatelematics.com/v2/telematics/vehicles/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.catenatelematics.com/v2/telematics/vehicles/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

{
  "code": 400,
  "message": "Bad Request",
  "detail": "<string>"
}

{
  "code": 401,
  "message": "Unauthorized",
  "detail": "<string>"
}

{
  "code": 403,
  "message": "Forbidden",
  "detail": "<string>"
}

{
  "code": 404,
  "message": "Not Found",
  "detail": "<string>"
}

{
  "code": 405,
  "message": "Method Not Allowed",
  "detail": "<string>"
}

{
  "code": 409,
  "message": "Conflict",
  "detail": "<string>"
}

{
  "code": 422,
  "message": "Invalid Request Body",
  "detail": [
    {
      "path": "<string>",
      "input": "<string>",
      "message": "<string>",
      "error_type": "<string>"
    }
  ]
}

{
  "code": 429,
  "message": "Too Many Requests",
  "detail": {
    "retry_after_seconds": 123,
    "message": "<string>"
  }
}

{
  "message": "Internal Server Error"
}

{
  "code": 501,
  "message": "Not Implemented",
  "detail": "<string>"
}

{
  "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "asset",
  "operation_type": "create",
  "payload": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "partner_ref": "<string>",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "success",
      "error_type": "auth",
      "error_details": "<string>",
      "response_status_code": 123,
      "response_headers": {}
    }
  ]
}

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.

Path Parameters

string<uuid>

required

The unique identifier of the vehicle

Query Parameters

is_sync

boolean

default:false

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

application/json

Vehicle model for updating existing 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.

partner_ref

string | null

Your own reference for this record. Optional, up to 255 characters, opaque to Catena: it is stored and returned unchanged on the resource operation, its GET endpoints and the resource_operation.* webhooks, so you can match the outcome of a write to the record in your system without keeping the operation ID.

Maximum string length: 255

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,

DIESEL,

ETHANOL,

METHANOL,

PROPANE,

LPG,

CNG,

LNG,

HYDROGEN,

ELECTRICITY,

HYBRID

Response

The vehicle was updated successfully.

Resource operation model

partner_id

string<uuid>

required

The ID of the partner that created the operation.

connection_id

string<uuid>

required

The ID of the connection

resource

enum<string>

required

The type of resource to operate on (e.g., vehicle, driver).

Available options:

asset,

document,

driver_association,

driver_vehicle_association,

driver_event_log,

driver_safety_event,

dvir_log,

dvir_log_defect,

engine_log,

engine_status,

fuel_transaction,

fuel_card,

fleet_info,

hos_availability,

hos_daily_log,

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

operation_type

enum<string>

required

The type of operation to perform (e.g., create, update).

Available options:

create,

update

payload

Operation Payload · object

required

The payload of the operation, containing the resource attributes to be created or updated.

string<uuid>

Unique identifier for the resource operation.

created_at

string<date-time>

Immutable: The datetime the record was created in Catena Telematics.

updated_at

string<date-time>

The datetime the record was last modified in Catena Telematics.

deleted_at

string<date-time> | null

The datetime the record was logically deleted from Catena Telematics.

partner_ref

string | null

The reference you supplied for this record when creating the operation, returned unchanged. null when none was supplied.

resource_id

string<uuid> | null

Unique identifier of the record. Can be null for create operations where the source does not exist yet.

source_id

string | null

The unique identifier of the resource in the source system. Required for update operations.

status

enum<string>

default:pending

The status of the operation

Available options:

pending,

success,

failed

logs

ResourceOperationLog · object[]

Log entries for each attempt to execute this operation.

Show child attributes

Overview

Authentication

Telematics

Organizations

Integrations

Notifications

Intelligence

Authorizations

Path Parameters

Query Parameters

Body

Response