Skip to main content
PATCH
/
v2
/
telematics
/
trailers
/
{id}
Update Trailer
curl --request PATCH \
  --url https://api.catenatelematics.com/v2/telematics/trailers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "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",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "<string>",
  "status": "pending",
  "logs": [
    {}
  ]
}

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.

Path Parameters

id
string<uuid>
required

The unique identifier of the trailer

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

Trailer 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.

trailer_name
string | null

Display name or unit number for the trailer.

oem
string | null

Manufacturer (OEM) of the trailer.

model_type
string | null

Manufacturer model or type designation (e.g., '53ft Dry Van', 'Reefer').

model_year
integer | null

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

vin
string | null

Vehicle Identification Number (VIN), typically 17 characters; 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-2, e.g., 'US', 'CA').

license_plate_number
string | null

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

is_active
boolean | null

Indicates whether this trailer is currently active/in service.

status
string | null

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

notes
string | null

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

eld_id
string | null

Telematics/ELD device identifier associated with this trailer, 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 trailer.

external_id
string | null

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

trailer_length
number | null

Length of the trailer (numeric; unit per source, e.g., feet or meters).

trailer_type
string | null

Body type/classification (e.g., Dry Van, Reefer, Flatbed, Tanker, Chassis).

Response

The trailer 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,
driver_association,
driver_vehicle_association,
driver_event_log,
driver_safety_event,
dvir_log,
dvir_log_defect,
engine_log,
engine_status,
fuel_transaction,
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
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.

id
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.

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
Logs · object[]

Log entries for each attempt to execute this operation.