Overspeed Event

Update overspeed event

This endpoint allows you to update an overspeed event associated to a tracker.

PATCH {baseUrl}/tracker/event/:eventId

Request Body

Field
Type
Required
Description

eventConfig

object

Configuration settings for the event.

eventConfig.speedLimit

number

The speed limit in km/hr) that triggers the event.

eventNotification

object

Optional notification settings for the event.

eventNotification.acceptedMediums

array

A list of notification channels and their settings.

eventNotification.status

string

Status of the notification configuration. Accepts either "inactive" or "active"

Sample Success Data

//Sample Request Body
{
    "eventConfig": {
        "speedLimit": 25
    },
    "eventNotification": { 
      "acceptedMediums": [
        {
          "channel": "email",
          "isEnabled": true,
          "defaultEmail": [ "[email protected]" ]
        },
        {
          "channel": "sms",
          "isEnabled": true,
          "defaultPhone": [ "+2349088888888" ]
        },
        {
          "channel": "inApp",
          "isEnabled": false
        }
      ],
      "status": "active"
    }
}

Sample Success Response

//Sample success response
{
    "status": true,
    "message": "Tracker event successfully updated",
    "data": {}
}

Last updated