v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Create a new Geofence (Polygon)

post/v1/geofences

Request body

namestring required

Specify the name of the geofence that you are creating.

statusstring

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

addressstring

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

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'

location_pointsstring[]

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

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",
    "location_points": [
      {
        "lat": 33.667893,
        "lon": 73.062074
      }
    ]
  }
}