v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Create a new Geofence (Circular)

post/v1/geofences/circular

Request body

namestring required

Specify the name of the geofence that you are creating.

categorystring required

Specify the category for which you are creating the Geofence. Allowed 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'

addressstring

Specify the address of the location for which you are creating this Geofence.

radius_in_metersnumber float

Specify the radius of the circular Geofence in meters.

centre_latnumber float

Specify the latitude of the center of the circular Geofence.

centre_lonnumber float

Specify the longitude of the center of the circular Geofence.

statusstring

Specify the status of the Geofence that you are creating. Allowed values are active or deactivated.

descriptionstring

Provide a short description for the Geofence.

Response

201

Example response

{
  "geofence": {
    "id": 1004,
    "name": "alpha",
    "category": "Fuel Station",
    "status": "active",
    "address": "1303 N Collins St, Arlington, TX 76011, USA",
    "description": "notes of geofence",
    "radius_in_meters": 500,
    "centre_lat": 33.667893,
    "centre_lon": 73.062074
  }
}