Skip to main content

UpdateGeofenceRequest

Schema for updating an existing geofence.

Supports three geometry types (PRD §3.1):

  • Polygon: Standard GeoJSON Polygon
  • MultiPolygon: Collection of polygons
  • Circle: Point with radius_meters
name object
anyOf
string

Possible values: non-empty and <= 100 characters

description object
anyOf
string

Possible values: <= 500 characters

geometry object

GeoJSON geometry (Polygon, MultiPolygon, or Circle)

anyOf
typeType (string)required

Possible values: Value must match regular expression ^Polygon$

coordinatesarray[]required
webhook_url object
anyOf
string

Possible values: <= 2048 characters

webhook_events object
anyOf
  • Array [
  • string
  • ]
  • metadata object
    anyOf
    object
    is_active object
    anyOf
    boolean
    group_name object
    anyOf
    string

    Possible values: <= 255 characters

    tags object

    Optional list of tag names. None leaves tags untouched; an empty list clears all tags; a non-empty list atomically replaces the geofence's tag set.

    anyOf
  • Array [
  • string
  • ]
  • address object

    Updated address (only honored on source='address' fences; re-geocodes if changed from the persisted value).

    anyOf
    string

    Possible values: <= 512 characters

    buffer_meters object

    Updated buffer radius in meters (1-10000; address-source fences only). Range matches CreateGeofenceRequest so bulk-imported fences with buffers outside the interactive UI's 10-1000 m default can still be edited via the API.

    anyOf
    integer

    Possible values: >= 1 and <= 10000

    UpdateGeofenceRequest
    {
    "name": "string",
    "description": "string",
    "geometry": {
    "type": "string",
    "coordinates": [
    0
    ]
    },
    "webhook_url": "string",
    "webhook_events": [
    "string"
    ],
    "metadata": {},
    "is_active": true,
    "group_name": "string",
    "tags": [
    "string"
    ],
    "address": "string",
    "buffer_meters": 0
    }