Updating Asset Details via the Telematics Guru API
A RESTful API POST request for updating asset details in your Org
Table of Contents
New to Using APIs?
Before using this endpoint, review the asset details available via the Asset Details GET Request documentation. This will help you understand how to configure an API tool, the structure of asset records and prepare your bulk update payload effectively.
What Asset Details Can I POST via the TG API?
We've updated the TG API functionality further with new POST requests, using the Update Bulk Assets endpoint. This new feature allows you to update asset details in bulk, which is ideal for modifying fields such as Department Id
, Project Id
, Asset Type Id
, Project From Date
, Rate Per Distance
, Rate Per Hour
and Billing From Date
.
This new POST endpoint empowers you to modify multiple asset records simultaneously, streamlining your workflow and ensuring that your asset details remain accurate across your organisation. This capability is especially useful when updating common fields across a range of assets.
POST Request Configuration
Here is the POST request endpoint to enable bulk asset updates:
https://{{Instance}}/v3/organisation/{{target organisation id}}/bulkupdateassets
Your instance will be the underlying server that hosts your Organisations on TG prefixed with api-
.
For example: api-apac03
or api-emea02
.
Your org id should be taken from the GET request for organisation details and will be an integer.
Example:
https://api-apac02/v3/organisation/123/bulkupdateassets
POST Request Payload
The JSON payload must adhere to the following field formats:
-
ID Fields: Fields like
DepartmentId
,ProjectId
, andAssetTypeId
must be provided as numbers or set tonull
if not applicable. -
Date Fields: Fields such as
ProjectFromDateUTC
andBillingFromDateUTC
should be provided as strings (e.g., in ISO 8601 format). -
Rate Fields: Fields like
RatePerDistance
andRatePerHour
are expected to be numeric values. - Serial Numbers: Device serial numbers should be delimited by a comma.
Finding your DepartmentId and ProjectId
The following endpoints will assist you to obtain the Department and Project IDs:
https://{{Instance}}/v3/organisation/{{target organisation id}}/departments
https://{{Instance}}/v3/organisation/{{target organisation id}}/departments
Example JSON Payload
The TG API will return a JSON array off all assets in your specified organisation, with the following data for each asset:
{
"DepartmentId": 102,
"ProjectId": 203,
"AssetTypeId": 304,
"ProjectFromDateUTC": "2025-04-01T00:00:00Z",
"RatePerDistance": 0.75,
"RatePerHour": 15.0,
"BillingFromDateUTC": "2025-04-01T00:00:00Z",
"SerialNumbersCSV": "123456,123457"
}
Response
A successful request will return a response indicating that the assets have been updated. For example:
{
"success": true,
"message": "2 assets updated"
}