geofence.update

The geofence.update command is used to update an existing geofence.

TR50 Request

{
  "cmd": {
    "command": "geofence.update",
    "params": {
      "key": "mygeofence",
      "points": [
        [
          26.394916, 
          -80.112571
        ]
      ],
      "radius": 3.0
    }
  }
}

Request Parameters

Name

Type

Required

Description

key

String

Yes

The key of the geofence to update.

name

String

 

The updated name of the geofence.

points

Array

 

The updated points of the geofence. A point is an array consisting of two floats: [latitude, longitude].

Points are only required to update polygonal geofences or to update the center of a circular geofence. Points are not required to update the radius.

radius

Float

 

The updated radius for a Radial geofences, in kilometers. Requires the point to also be specified in the request.

tags

Array

 

The updated array of tags to be assigned to the geofence.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message are returned.

{
  "cmd": {
    "success": true
  }
}