Update a geofence

Places module

PATCH/geofences/{id}geofences.update

A geofence used for Compass clock in. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability org.time_attendance.write.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

geofences.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the geofence.

Request body: GeofenceUpdate

geofences.update: GeofenceUpdate
Field	Type	Required	Description
name	string	No	Geofence name.Constraints: length 1 to 300
zone_id	string (uuid) \| null	No	Identifier of the zone the geofence outlines.
boundary	GeoJsonPolygon	No	A GeoJSON Polygon in WGS 84 (RFC 7946): rings of [longitude, latitude] positions.

{
  "name": "Harborfront Site",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: Geofence

geofences.update: Geofence
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the geofence.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Geofence name.Constraints: length 1 to 300
venue_id	string (uuid)	Yes	Identifier of the venue.
zone_id	string (uuid) \| null	Yes	Identifier of the zone the geofence outlines.
boundary	GeoJsonPolygon	Yes	A GeoJSON Polygon in WGS 84 (RFC 7946): rings of [longitude, latitude] positions.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Harborfront Site",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "boundary": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -80.19,
          25.77
        ],
        [
          -80.18,
          25.77
        ],
        [
          -80.18,
          25.78
        ],
        [
          -80.19,
          25.77
        ]
      ]
    ]
  }
}

Code samples

curl -X PATCH "$XOS_BASE_URL/geofences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"name":"Harborfront Site","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data, etag } = await xos.geofences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Harborfront Site",
    "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });

response = xos.geofences.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Harborfront Site", "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)

xos geofences update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Harborfront Site","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto