Update a geofence referenced by its geofenceId. A geofenceId is generated for all geofences and can be found in the Pilgrim Console.




User authentication.


Name Example Description
name My Deals and Offers A custom string that you can set to help you identify the set of geofences.
venueId 412d2800f964a520df0c1fe3 A single Foursquare venueId.
categoryId 4bf58dd8d48988d1d4941735 A single Foursquare category.
chainId 556ce426aceaff43eb04e8a0 A single Foursquare chain.
center 40.7435179,-73.988242149 A comma separated lat/long coordinate.
radius 100 Area around the lat/lng that will trigger a geofence event. Default and miniumum radius is 50 meters with a max of 5000.
dwellTime 2 Number of minutes user needs to be inside of a geofence to trigger a dwell event. Default is 1 minute.

Response Fields

Field Description
geofence A geofence object containing an id, name, type, and boundary.
id A unique string identifier for this geofence.
name Name of the geofence that will appear in the Pilgrim Console.
type Can be either Venue, LatLng, or Polygon.
boundary Bounds of the geofence. For polygons it will be an array of points.
radius Area around the lat/lng that will trigger a geofence event.


    "meta": {
        "code": 200,
        "requestId": "5cab901e4c1f6715dfb6dee7"
    "notifications": [
            "type": "notificationTray",
            "item": {
                "unreadCount": 0
    "response": {
        "geofence": {
            "type": "LatLng",
            "name": "My Custom Location",
            "id": "5cab901ebfc6d0002ce1ff33",
            "boundary": {
                "center": {
                    "lat": 40.7435179,
                    "lng": -73.988242149
                "radius": 100
            "dwellTime": 2
Was this page helpful?
Thank you!