Skip to main content
PUT
Update geofence

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Path Parameters

id
string
required

Unique identifier of the geofence, generated by the system. Example: 66e0a1b2c3d4e5f6a7b8c9d0

Body

application/json
name
string

Name of the geofence. Maximum 100 characters, unique within your organization. Example: Warehouse A

Maximum string length: 100
inputType
string

The input type of the component (e.g., string, number, date, etc.)

dwellMinutes
integer

Minutes a driver must stay inside before an enter alert is raised. 0 to 1440. Example: 5

Required range: 0 <= x <= 1440
groupId
string

Geofence group id, or null for no group. Example: 66e0a0b1c2d3e4f5a6b7c8d9

isActive
boolean

Only active geofences raise alerts. Example: true

color
string

Display color. Maximum 9 characters. Example: #1E88E5

Maximum string length: 9
geometry
object

Polygon shape, required when type is polygon. GeoJSON Polygon with exactly one ring of at least 3 points; the ring is closed automatically and must not cross itself. Coordinates are [longitude, latitude]; longitude between -180 and 180, latitude between -90 and 90.

center
object

Circle center, required when type is circle. Coordinates are [longitude, latitude]; longitude between -180 and 180, latitude between -90 and 90.

radius
number

Circle radius in meters, required when type is circle. 1 to 50000. Example: 250

Required range: 1 <= x <= 50000

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

Updated geofence.