Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Geofence

Create a geofence

post/geofence

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

custom_idstring

Set an unique ID for the new geofence. If not provided, an ID will be automatically generated in UUID format. A valid custom_id can contain letters, numbers, "-", & "_" only.

Please note that the ID of a geofence can not be changed once it is created.

type'circle' | 'polygon' | 'isochrone' required

Specify the type of the geofence that is being created.

namestring

Name of the geofence. Use this field to assign a meaningful, custom name to the geofence being created.

tagsstring[]

An array of strings to associate multiple tags to the geofence. tags can be used to search or filter geofences (using Get Geofence List method).

Create valid tags using a string consisting of alphanumeric characters (A-Z, a-z, 0-9) along with the underscore ('_') and hyphen ('-') symbols.

meta_dataobject

Metadata of the geofence. Use this field to define custom attributes that provide more context and information about the geofence being created like country, group ID etc.

The data being added should be in valid JSON object format (i.e. key and value pairs). Max size allowed for the object is 65kb.

Example request

{
  "type": "\"type\":\"circle\"",
  "name": "\"name\":\"Los Angeles Downtown\"",
  "tags": [
    "\"tags\":[\"tags_1\", \"O69Am2Y4KL8q5Y5JuD-Fy-tdtEpkTRQo_ZYIK7\"]"
  ],
  "isochrone": {
    "coordinates": "\"coordinates\": \"13.25805884,77.91083661\"",
    "mode": "\"mode\":\"car\""
  }
}

Response

OK

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.