Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Geofence

Partially updates geofence information

⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward.

Partially updates one or more fields on an existing legacy geofence record. Only the fields included in the request body are modified; all other fields retain their current values. Returns the full updated Geofence object on success.

About Update Geofence — Partial (Legacy)

This PATCH endpoint applies partial updates to a legacy geofence definition using the GeofenceUpdate schema, which accepts name, description, latitude, longitude, radius, radius_unit, and device_actions. Unlike PUT, omitted fields are preserved. Changes made here do not affect blueprint-managed geofence behavior; use /api/v2/blueprints/ for all active configuration management.

patch/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/

Path parameters

geofence_idstring uuid required

A UUID string identifying the geofence.

enterprise_idstring uuid required

A UUID string identifying the enterprise.

Response

successful operation

idstring uuid

id of the geofence

namestring required

Name of the geofence

descriptionstring

A description about the geofence

enterprisestring uuid

id of the enterprise resource

latitudestring decimal required

Latitude corresponding to the geofence

longitudestring decimal required

Longitude corresponding to the geofence

radiusinteger

The radius within which the geofence should be applied

radius_unit'KILOMETERS' | 'METERS' | 'MILES'

The unit in which the radius is taken, eg - kilometers, meters etc

device_actionsstring[]

The actions to be performed on the device

device_countinteger

Number of devices

created_bystring

The user who created the geofence

created_onstring date-time

Date and time of when the geofence was created

updated_onstring date-time

Date and time of when the geofence was updated