v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Update an existing Geofence

put/v1/geofences/{id}

Path parameters

idinteger required

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

Request body

namestring

Update the name of the Geofence.

categorystring

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_pointsstring[]

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

statusstring

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

descriptionstring

Provide a short description for the 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.

Response

200

Example response

{
  "geofence": {
    "id": 1004,
    "name": "alpha",
    "category": "Fuel Station",
    "status": "active",
    "description": "notes for geofence",
    "address": "1303 N Collins St, Arlington, TX 76011, USA",
    "location_points": [
      {
        "lat": 33.667893,
        "lon": 73.062074
      }
    ]
  }
}