Create Moving-Geofence API

The create Moving Geofence API is responsible for creating moving-geofences for projects.

post
Create Moving-Geofence API

https://api.roam.ai/v1/api/moving-geofence/
Request
Response
Request
Headers
Api-key
required
string
Auth-key E.g.- 332223kfhdjahsiebjsb5s
Body Parameters
users
required
array
Array of user_ids to create moving-geofences. E.g.- ["5f520949e3872b0341bcf3e7", "5f520955e3872b0341bcf3e8", "5f083247b3611453c98a726f"]
metadata
optional
array
An optional set of custom key-value pairs for the geofence.
geometry_type
required
string
Defines the type of geometry. E.g.- circle
geometry_radius
required
integer
Defines the radius of circular geofence in meters. Range 50m to 1000m. (Required only for geometry_type circle. Field value ignored if sent when geometry_type is a polygon.) E.g.- 50m to 1000m max
color_code
optional
string
Defines the color of Geofence and how it is displayed on the dashboard. Type: Hex Code for CSS colors. Note: Pass the code without '#'. E.g.- ffffff
tag
optional
string
Tag the GeoFences for future reference and filtering. E.g.- hotel
description
optional
string
Optional description for the geofence. E.g.- This is just a 5-star cool hotel where you can stay.
is_enabled
optional
boolean
Enable/Disable 'event_trigger' for Geofences. By default event triggers are disabled. E.g.- true or false
Response
200: OK
{
"status": true,
"msg": "Geofence Added successfully.",
"code": 201,
"data": {
"id": "5f9801aeffb3fb0de55e863d",
"account_id": "5bda16a2ea00845b3b419160",
"project_id": "5bda16edea00845b3b419163",
"geometry_type": "circle",
"geometry_radius": 500,
"is_enabled": true,
"is_deleted": false,
"created_at": "2020-10-27T11:17:02.956",
"updated_at": "2020-10-27T11:17:02.959",
"only_once": true,
"users": [
"5f520949e3872b0341bcf3e7",
"5f520955e3872b0341bcf3e8"
]
}
}

Sample Request

curl --location --request POST 'https://api.roam.ai/v1/api/moving-geofence/' \
--header 'Api-Key: e566c098cc6b441a9c3453b6fcf76e88' \
--header 'Content-Type: application/json' \
--data-raw '{
"geometry_type": "circle",
"geometry_radius": 500,
"is_enabled": true,
"only_once": true,
"users": ["5f520949e3872b0341bcf3e7","5f520955e3872b0341bcf3e8","5f083247b3611453c98a726f"]
}'