UPDATE Geofence API
Use this API to update details for an existing geofence of any specific project.
Last updated
Use this API to update details for an existing geofence of any specific project.
Last updated
Api-key
string
Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f
geofence_id
string
geofence_id which needs to be updated E.g.- 6dba14deda01857c3c418265
group_ids
array
Enables geofence for the list of users. If group_ids and user_ids are empty then geofence is enabled for all users of the project. E.g.- ["group1","group2"]
user_ids
array
Enables geofence for the list of users. If group_ids and user_ids are empty then geofence is enabled for all users of the project. E.g.-["user1","user2"]
coordinates
array
Mandatory for creating the geofence. E.g.- [ -72.28122, 42.926042 ]
metadata
object
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
array
Array with first index depicting whether the geofence is enabled or disabled, second index depicting the start_time and last index depicting the end_time between which the geofence should be active. E.g.- [true,"2021-06-10T20:45:44", "2021-06-15T22:45:33"]