Add new fence to a project

The Add new fence to a project endpoint creates a new fence and automatically links it to a single project.

• The easiest way to add a new fence is by adding a new one to a project.
• Instead of listing fences in the request body, a new fence can be added to the single project selected in the request URL.

HTTPS method: POST

For ease of viewing and identification:

• Required constants and parameters are shown in bold text.
• Optional parameters are shown in plain text.

https://baseURL/geofencing/versionNumber/projects/projectId/fence?key=Your_API_Key&adminKey=Your_Admin_Key

curl command

curl -XPOST -H "Content-type: application/json" -d '{
  "name": "fence_name",
  "type": "Feature",
  "geometry": {
    "radius": radius_in_meters,
    "type": "Point",
    "shapeType": "shape_type",
    "coordinates": [longitude, latitude]
  },
  "properties": {             //Optional
    "key": "value"
  }
}' 'https://baseURL/geofencing/versionNumber/fences/fence?key=Your_API_Key&adminKey=Your_Admin_Key'>

POST request body (JSON)

{
  "name": "fence_name",
  "type": "Feature",
  "geometry": {
    "radius": radius_in_meters,
    "type": "Point",
    "shapeType": "shape_type",
    "coordinates": ["longitude", "latitude"]
  },
  "properties": {
    "key": "value"
  }
}

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.
• Optional parameters may be used.
• If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
• The order of request parameters is not important.

Response body (JSON)

{
  "name": "fence_name",
  "id": "fence_id",
  "type": "Feature",
  "geometry": {
    "radius": radius_in_meters,
    "type": "Point",
    "shapeType": "shape_type",
    "coordinates": ["longitude, latitude"]
  },
  "properties": {
    "key": "value>"
  }
}

Response fields

The following table describes all of the response fields.

▲ Return to top

HTTP response codes

Request URL

https://api.tomtom.com/geofencing/1/projects/44de824d-c368-46cf-a234-a6792682dfd6/fence?key=Your_API_Key&adminKey=Your_Admin_Key

POST request body (JSON)

{
  "name": "No-fly zone 23",
  "type": "Feature",
  "geometry": {
    "radius": 75,
    "type": "Point",
    "shapeType": "Circle",
    "coordinates": [-67.137343, 45.137451]
  },
  "properties": {
    "maxSpeedKmh": 70
  }
}

Response body (JSON)

{
  "name": "No-fly zone 23",
  "id": "aaab6d78-1738-45bd-a78b-ff3a7ba839f3",
  "type": "Feature",
  "geometry": {
    "radius": 75,
    "type": "Point",
    "shapeType": "Circle",
    "coordinates": [-67.137343, 45.137451]
  },
  "properties": {
    "maxSpeedKmh": 70
  }
}