ESesper
esper_cloud_api_Geofence

Create a geofence

⚠️ 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.

Creates a new geofence and optionally applies it to a list of devices in a single request. Returns the newly created Geofence object (HTTP 201) with the assigned UUID; the devices field allows immediate application to specific devices at creation time, a capability not available through the separate /geofence/ path endpoints.

post/v0/enterprise/{enterprise_id}/create-apply-geo-fence/

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/v0/enterprise/{enterprise_id}/create-apply-geo-fence/
  • Auth
    HTTP bearer

Path parameters

enterprise_idstring uuid required

A UUID string identifying the enterprise.

Request body */*

namestring

Name of the geofence

descriptionstring

A description about the geofence

latitudestring decimal

Latitude corresponding to the geofence

longitudestring decimal

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

devicesstring[]

List of ids of devices on which the geofence is to be applied

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.