Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-08-063010285.3 KB
Geofencing Notifications

Subscribe to geofencing notifications for a VIN and geofence collection.

Subscribe endpoints such as phone numbers, email addresses, and head unit VINs to geofencing notifications. Subscribed head unit VINs will receive in-vehicle popups with geofence breach information.

post/v1/geofencing-notifications/subscribe

Request body

vinstring required
collection_namestring required
HU_vin_for_popupstring
phone_numbersstring[]
emailsstring[]

Example request

{
  "vin": "3D7UT2CL0BG625027",
  "collection_name": "collection_name",
  "HU_vin_for_popup": "3D7UT2CL0BG625054",
  "phone_numbers": [
    "+12345678900"
  ],
  "emails": [
    "your_email@domain.com"
  ]
}

Response

string required

Example response

"Success! Subscriptions to vin: 3D7UT2CL0BG625027 and geofence collection: collection_name breach event added successfully."