Update Moving-Geofence API

The Update Moving-Geofence API allows you to update the details for an existing moving geofence for any specific project using the Update Geofence API.

Update Moving-Geofence API

PUT https://api.roam.ai/v1/api/moving-geofence/

Headers

Name
Type
Description

Api-key

string

Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f

Request Body

Name
Type
Description

geofence_id

string

geofence_id which need to be updated. E.g.- 5bd2aee1eec1a50d8faf1293

metadata

array

An optional set of custom key-value pairs for the geofence.

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

{
    "status": true,
    "msg": "Geofence updated successfully.",
    "code": 200,
    "data": {
        "id": "5f9801aeffb3fb0de55e863d",
        "account_id": "5bda16a2ea00845b3b419160",
        "project_id": "5bda16edea00845b3b419163",
        "geometry_type": "circle",
        "geometry_radius": 500,
        "is_enabled": true,
        "description": "testing geofence",
        "color_code": "ggggg",
        "tag": "border code",
        "is_deleted": false,
        "created_at": "2020-10-27T11:17:02.956",
        "updated_at": "2020-10-27T11:20:33.050",
        "only_once": true,
        "users": [
            "5f520949e3872b0341bcf3e7",
            "5f520955e3872b0341bcf3e8"
        ]
    }
}

Sample Request

curl --location --request PUT 'https://api.roam.ai/v1/api/moving-geofence/' \
--header 'Api-Key: e566c098cc6b441a9c3453b6fcf76e88' \
--header 'Content-Type: application/json' \
--data-raw '{
	"geofence_id": "5f9801aeffb3fb0de55e863d",
	"is_enabled": true,
	"description": "testing geofence",
	"tag": "border code",
	"color_code": "ggggg"
 }'

Last updated