API

Specifications

Overview - Changelog


Published On Not Released
Published On 12 December 2025

v1.0.40 #

Remote API

  • Set/Unset Drive alert feature.

Published On Not Released
Published On 24 November 2025

v1.0.39 #

Monitor and Telemetry API’s

  • CreatedAt added to fuel consumption section for latest telemetry.
  • Schedule object added to Time Trigger entry for monitors.
  • Times array marked as deprecated in time trigger entry for monitors.

Published On Not Released
Published On 29 September 2025

v1.0.38 #

EndPoint Update

  • Updated timestamps examples to allow filtering of records by milliseconds.
  • Updated text of Trigger Params while creating monitors.

Published On Not Released
Published On 19 September 2025

v1.0.37 #

EndPoint Update

  • Updated HTTP return code for end points.

Published On Not Released
Published On 15 September 2025

v1.0.36 #

Channels and Telemetry API

  • Devices made optional on get Channels.
  • Propulsion/brakingSystem and location removed from telemetry type for filtering telemetry records.
  • Polygon added as another way of defining area of zone alerts.

Published On Not Released
Published On 8 September 2025

v1.0.35 #

Channels and Vehicle API

  • project Id mandatory while creating channels
  • FuelTank object updated in latest telemetry
  • Fuel Type updated from character to string in vehicles API
  • Immobilization remote command removed as it is covered under stolen action

Published On Not Released
Published On 25 August 2025

v1.0.34 #

Pre Conditioning and Digital Key Notification Updates

  • Added new failure reasons for remote Command Pre conditioning
  • Added new statuses for digital key notifications

Published On Not Released
Published On 20 August 2025

v1.0.33 #

OEM Channel Updates

  • Added new channel type as OEM while creating channels/monitors/remotes.

Published On Not Released
Published On 18 August 2025

v1.0.32 #

Battery Resource Updates

  • Removed current resource from battery update.
  • Added residual field to battery resource.

Published On Not Released
Published On 7 August 2025

v1.0.31 #

Channel API

  • added two new field titleiOS and bodyiOS to push notif attribute set while creating channel

Published On Not Released
Published On 5 August 2025

v1.0.30 #

createdAt/updatedAt Updates

  • createdAt/updatedAt will be updated for monitor resource.

Published On Not Released
Published On 1 August 2025

v1.0.29 #

tyre Parameters And Charge Deferred Updates

  • tyre Parameters are updated
  • Charge Deferred State is accepted: APIM will receive either start or end at a time, not both together.

Published On Not Released
Published On 28 July 2025

v1.0.28 #

createdAt, updatedAt & Delete Action Updates

  • createdAt and updatedAt added to all channel resources
  • Delete action type added to remote preconditioning programs

Published On Not Released
Published On 21 July 2025

v1.0.27 #

Trip API & Deferred Charge Updates

  • Trips API updated with mandatory vs optional fields
  • End added to deferred charge section

Published On Not Released
Published On 10 July 2025

v1.0.26 #

Deferred Charge Updates

  • Deferred charge block added to remote charging command.
  • Telemetry API updated to add deferred charge details to charging block

Published On Not Released
Published On 20 June 2025

v1.0.25 #

Collision Updates

  • Updated collision object.
  • Added new field “unlockRequested”.
  • Added two new side enums

Published On Not Released
Published On 6 June 2025

v1.0.24 #

Telemetry, Charging, Channel, and Trip API Updates

  • Mandatory vs optional fields updated for telemetry end point
  • Temp removed from charging programs as temp is not supported for remote charging programs
  • For channel creation, push notification attributes marked mandatory
  • Offroad/speed violation option taken out from trip waypoints end point

Published On Not Released
Published On 23 May 2025

v1.0.23 #

Telemetry and Trip API

  • Telemetry & Trip response updated with mandatory vs optional fields
  • Example for Push Notification Attribute updated as per the Schema
  • Debug field marked as mandatory in error response

Published On Not Released
Published On 02 May 2025

v1.0.22 #

Channel and Monitor API

  • Timing example updated in timestamps parameter
  • Modified description for Update channel
  • Corrected spelling mistake for Monitor Attribute

Published On Not Released
Published On 25 Apr 2025

v1.0.21 #

Channel and Monitor API

  • Channel Attributes can have type only as header/query
  • Remote/Monitor attributes can have type only as Body
  • $vin replaced with $Vin for specifying VIN in attributes for channel/remote/monitor

Published On Not Released
Published On 11 Apr 2025

v1.0.20 #

Capabality and Monitor API

  • Temperature field added to preconditioning in capability API
  • TAN remote action support
  • Add fleet support as group handle to Monitor handle
  • Example for Time Trigger entry fixed to match the object definition

Published On Not Released
Published On 04 Apr 2025

v1.0.19 #

Trip and Telemetry API

  • Locale parameter removed from trips alert end point
  • Powertrain added to latest telemetry response

Published On Not Released
Published On 28 Mar 2025

v1.0.18 #

Vehicle API

  • Temperature added to programs section for remote preconditioning
  • Description updated for devices for Push Notification. APIM will not allow Device to be empty string
  • AuthorizationError added to existing enums of Remote Command Failure
  • Type field in web socket attribute will not have default value
  • Added extended event params support while sending remote commands to vehicle

Published On Not Released
Published On 14 Mar 2025

v1.0.17 #

Trip API

  • AverageConsumption and sub type added to energy block under stats in Trips API
  • Updated text for pageSize and indexRange. 400 will be returned if these parameters are sent in request along with pageToken

Published On Not Released
Published On 28 Feb 2025

v1.0.16 #

Vehilcle API and Trip API

  • On Board capability API exposition
  • Support remote end time charging
  • Two new end points to provide charging history
  • Kinetic element restructuring in Trip end point
  • Extended event params alignment and renaming for monitors
  • Added Eco coaching API

Published On Not Released
Published On 17 Feb 2025

v1.0.15 #

Trip API

  • removed offroad and boundary from kinetics filter for get trips API

Published On Not Released
Published On 31 Jan 2025

v1.0.14 #

Telemetry API

  • Alert structure update for telemetry to be in SYNC with latest telemetry
  • createdAt date added at root level of telemetry

Published On Not Released
Published On 23 Jan 2025

v1.0.13 #

Vehicle API

  • Removed Vehicle Config remote command as Digital key related APIs are not supported by APIM

Published On Not Released
Published On 17 Jan 2025

v1.0.12 #

Trip API and Telemetry API

  • Added recurrence field to time trigger for creating monitor
  • Added new entries to door state enum
  • Remove Ecocoaching & Offroad as trip types from trip filter

Published On Not Released
Published On 15 Dec 2024

v1.0.11 #

Trip API

  • Removed Unused APIs
  • Removed paging parameters from API to get specific trip details.

Published On Not Released
Published On 10 Nov 2024

v1.0.10 #

Telemetries and LatestTelemetries APIs

  • PreconditioningProgram: temperature (temp) and startCondition (startCond) added; slot and occurrence marked as required
  • Updated Alerts structure to add report and active alerts

Published On Not Released
Published On 20 Nov 2024

v1.0.9 #

Remote API

  • Remove offroad from trip Kinetic & tripContext.
  • Marked minChargingLevel & maxChargingLevel as mandatory.
    • Updated trip type to only support normal trip type.

Published On Not Released
Published On 25 Oct 2024

v1.0.8 #

Remote API

  • Remote Charging text update to accept only one of immediate/program/settings
  • Fields marked mandatory in remote charging command for program section
  • Remote Preconditioning text update to accept only one of immediate/program/settings.
  • Removed Eco Coaching related APIs and from trips response
  • Tracking period removed from stolen remote command
  • Extended Event Params removed from Remote Command
  • UpdatedAt field added to latest telemetry API response
  • Sort spelling correction
  • minChargingLevel & maxChargingLevel added to Remote Charging Programs

Published On Not Released
Published On 17 Oct 2024

v1.0.7 #

Remote API

  • Remote Preconditioning mark mandatory fields
  • Remote Charging marking mandatory fields
  • Remote navigation update field data type of placeId/postalCode from string to int
  • Update description of remote charging
  • Removed additional fields from Remote Navigation Object

Published On Not Released
Published On 10 Oct 2024

v1.0.6 #

Trip API

  • Add startEnergy/endEnergy/startMileage to trips response
  • Trigger parameters updated to support Digital Key & Last mile navigation
  • Devices marked as mandatory for push notif section while creating channel

Published On Not Released
Published On 27 Sep 2024

v1.0.5 #

Vehicles API

  • Updated state field from boolena to string for preconditioning
  • Corrected spelling mistake of enum value from confort to comfort in driving behavior
  • Updated description for create monitor & create channel to provide information on max channel & monitor to be created
  • Added field updatedAt for get monitor by Id end point
  • A channel wouldn’t be allowed to delete if its attached remotes are in pending state or monitors in running state.

Published On Not Released
Published On 17 Sep 2024

v1.0.4 #

Monitor and Telemetry API

  • Corrected type from occurence to occurrence
  • Added createdAt and updatedAt in POST and PUT in monitor APIs respectively
  • Tire Status removal from Telemetry Enum

Published On Not Released
Published On 17 Aug 2024

v1.0.3 #

Vehicles API

  • Added pnc Scope for B2B2C to be able to retrieve pcid/mac address information
  • Add pageSize, pageToken, timestamp and indexRange as query parameters for stolen waypoints end point-
  • Removed TripContext from position object for end points supporting stolen feature
    • /accounts/vehicles/{id}/stolen/{sid}/waypoints
    • /accounts/vehicles/{id}/stolen/{sid}
    • /accounts/vehicles/{id}/stolen
  • Added mac address to devices object to be used for auto charge feature
  • Latest telemetry Energy Charging block
    • Removed Charge Schedule
    • Renamed chargingRate field to chargingSpeed
    • programs and settings moved out of schedule and put into root level
    • Removed type field as it was redundant with ChargeLimit

Published On Not Released
Published On 20 Jul 2024

v1.0.2 #

Vehicles API

  • API changes to expose pcid information for PnC
  • Fixed data trigger op issues
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.locking.identifier
  • Removed Remote.action.Ignition
  • Removed Remote.action.panic
  • Removed Remote.action.preconditioning.airConditioning.immediate.identifier
  • Removed Remote.action.preconditioning.airConditioning.schedules.programs.duration
  • Removed Remote.action.preconditioning.airConditioning.schedules.programs.recurrence
  • Removed Remote.action.preconditioning.airConditioning.schedules.programs.scheduleType
  • Removed Remote.action.preconditioning.airConditioning.schedules.programs.config.batterySaver
  • Removed Modified airConditioning to have only immediate, programs and settings
  • Removed Remote.action.charging.charge.programs.scheduleType
  • Removed Remote.action.charging.charge.programs.recurrence
  • Removed Modified charging to have only immediate, programs and settings
  • Removed Remote.action.navigation
  • Removed Remote.action.vehicleFinder
  • Removed action query string

Published On Not Released
Published On 10 Aug 2024

v1.0.1 #

Vehicles API

  • API changes to expose pcid information for PnC
  • Fixed data trigger op issues