ESesper
esper_cloud_api_Geofence

Update 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.

Performs a full replacement update on an existing legacy geofence record.All writable fields must be included in the request body; omitting a field will overwrite it with a null or default value. Returns the updated Geofence object on success.

About Update Geofence — Full (Legacy)

This PUT endpoint replaces the entire geofence definition for the specified geofence_id. It operates on the same legacy standalone geofence system as the other /geofence/ path endpoints. Because geofences are now configured within blueprints via /api/v2/blueprints/, edits here will not affect blueprint-managed geofence behavior. Use blueprints for all active geofence configuration changes.

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

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/
  • Auth
    HTTP bearer

Path parameters

geofence_idstring uuid required

A UUID string identifying the geofence.

enterprise_idstring uuid required

A UUID string identifying the enterprise.

Request body */*

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

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

Changes

No recorded changes to this operation across all 6 revisions of this API.