Create Moving-Geofence API
The create Moving Geofence API is responsible for creating moving-geofences for projects.
Create Moving-Geofence API
POST
https://api.roam.ai/v1/api/moving-geofence/
Headers
Name | Type | Description |
---|---|---|
Api-key | string | Auth-key E.g.- 332223kfhdjahsiebjsb5s |
Request Body
Name | Type | Description |
---|---|---|
users | array | Array of user_ids to create moving-geofences. E.g.- ["5f520949e3872b0341bcf3e7", "5f520955e3872b0341bcf3e8", "5f083247b3611453c98a726f"] |
metadata | array | An optional set of custom key-value pairs for the geofence. |
geometry_type | string | Defines the type of geometry. E.g.- circle |
geometry_radius | 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 | 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 | string | Tag the GeoFences for future reference and filtering. E.g.- hotel |
description | string | Optional description for the geofence. E.g.- This is just a 5-star cool hotel where you can stay. |
is_enabled | boolean | Enable/Disable 'event_trigger' for Geofences. By default event triggers are disabled. E.g.- true or false |
Sample Request
Last updated