Update an existing Geofence

Purpose: Use this API to update an existing Geofence information.

šŸ“˜

NOTE

You must provide the ID of the Geofence in the Path Parameters, and name, location co-ordinates (latitude and longitude), as well status & center radius information in the request body. Refer to the Path Parameters & Body Parameters section for more info.

Sample Request Body

{
  "name":"bravo",
  "description": "notes for geofence",
  "location_points":[
    {
      "lat":33.667893,
      "lon":73.062074
    },
    {
      "lat":33.665052,
      "lon":73.067689
    },
    {
      "lat":33.662428,
      "lon":73.061814
    },
    {
      "lat":33.666374,
      "lon":73.058196
    },
    {
      "lat":33.667893,
      "lon":73.062074
    }
  ]
}

Response Parameters

Geofence

  • Type: Object
  • Description: Contains details of the geofence.

id

  • Type: Integer
  • Description: The unique identifier for the geofence.

name

  • Type: String
  • Description: The name of the geofence.

category

  • Type: String
  • Description: The category of the geofence, e.g., "Fuel Station".

status

  • Type: String
  • Description: The status of the geofence, e.g., "active".

description

  • Type: String
  • Description: Notes or description for the geofence.

address

  • Type: String
  • Description: The physical address associated with the geofence.

location_points

  • Type: Array of Objects
  • Description: A list of geographical points that define the boundaries of the geofence.

lat

  • Type: Float
  • Description: The latitude of a location point in the geofence.

lon

  • Type: Float
  • Description: The longitude of a location point in the geofence.

Path Params
int32
required

Specify the ID of the Geofence that you want to update.

Body Params
string

Update the name of the Geofence.

string

Update the category of the Geofence. Alowed values are: 'Uncategorized', 'Fuel Station', 'Job Site', 'Maintenance Facility', 'Receiver / Consignee', 'Restricted Location', 'Shipper', 'Terminal / Yard', 'Truck Stop / Rest Area', 'Weigh Station / Scale', 'Shipper / Receiver'

location_points
array of strings

Specify the latitude and the longitude of the Geofence. You must provide multiple latitudes and longitudes to form a polygon.

location_points
string
Defaults to active

Update the status of the Geofence. Allowed values are: active or deactivated.

string

Provide a short description for the Geofence.

float

Specify the radius of the circular Geofence in meters.

float

Specify the latitude of the center of the circular Geofence.

float

Specify the longitude of the center of the circular Geofence.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json