Add a Geofence

post

https://api.foursquare.com/v2/apps/{client_id}/geofences/add

Create the following types of geofences:

Around a FSQ Venue
Using a Custom Polygon
Around a Lat/Long Coordinate

Path Params

client_id

string

required

The unique ID associated with your developer project.

Query Params

oauth_token

string

required

The access token generated via your web application as described here.

name

string

required

A custom string that you can set to help you identify the set of geofences.

venueId

string

A single Foursquare venueId. Required if adding a geofence around a FSQ venue & if either a categoryId or a chainId is not provided.

categoryId

string

A single Foursquare categoryId. Required if adding a geofence around a FSQ venue & if either a venueId or a chainId is not provided.

chainId

string

A single Foursquare venueId. Required if adding a geofence around a FSQ venue & if either a venueId or a categoryId is not provided.

polygon

string

A string of URL encoded lat/lng points separated by semicolon, with start and end as the same points. Must provide between 4 and 15 points in a clockwise fashion to successfully create the polygon. Required if adding a geofence using a custom polygon.

center

string

A comma separated lat/lng coordinate. Required if adding a lat/long coordinate based geofence.

radius

int32

Area around the lat/lng that will trigger a geofence event. Default and miniumum radius is 50 meters with a max of 5000. Required if adding a lat/long coordinate based geofence.

dwellTime

int32

Number of minutes user needs to be inside of a geofence to trigger a dwell event. Default is 1 minute. Applies only to polygon and lat/long coordinate-based geofences.

string

required

The API version date as documented here

Response

200200