{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/geofences/:id","auth":"required","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff8265c135231700aed828"},{"name":"id","type":"string","default":"","desc":"Geofence ID. It can be fetched by \"Geofences: Get All (Index)\" endpoint.","required":true,"in":"path","ref":"","_id":"57890fa87a572c0e0011fd1c"},{"name":"geofence","type":"object","default":"","desc":"Geofences to be created","required":true,"in":"body","ref":"","_id":"58764a95b5092c1900586edc"},{"name":"geofence.name","type":"string","default":"","desc":"Name of geofence","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd1b"},{"name":"geofence.location","type":"array_float","default":"","desc":"Location of the geofence as [latitude, longitude]","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd1a"},{"name":"geofence.type","type":"string","default":"","desc":"Type of the geofence, can be one of: [\"enter\", \"exit\"]","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd18"},{"name":"geofence.shape","type":"string","default":"","desc":"polygonal or radial (optional)","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd17"},{"name":"geofence.radius","type":"string","default":"","desc":"Radius of the circle geofence in meters","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd16"},{"name":"geofence.path","type":"array_float","default":"","desc":"Path of the polygon geofence, as array of [latitude, longitude]","required":false,"in":"body","ref":"","_id":"57890fa87a572c0e0011fd15"}],"results":{"codes":[{"language":"json","code":"{\n    \"guid\": \"Mplgk91j\",\n    \"name\": \"A geofence name\",\n    \"path\": null,\n    \"radius\": 256,\n    \"shape\": \"radial\",\n    \"type\": \"enter\",\n    \"location\": [\n        53.2742762,\n        -9.049063799999999\n    ],\n    \"id\": \"5788b889636f6e953bbe0b00\"\n}","name":"","status":200}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","code":"curl -H 'Authorization: Token token=\"my_admin_api_token\"' https://control.pulsatehq.com/api/v1/geofences/:geofenceid\n\ncurl -X PUT \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/geofences/$GEOFENCE_ID\"\n  -H \"authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n    \"geofence\": {\n        \"name\": \"geofence_from_api_niepolomice\",\n        \"location\": [50.042754135466986, 20.207290649414062],\n        \"type\": \"enter\",\n        \"shape\": \"polygon\",\n        \"radius\": \"101\",\n        \"path\": [\n            [50.042754135466986, 20.207290649414062],\n            [50.02334733167384, 20.200166702270508],\n            [50.02433991532921, 20.235872268676758],\n            [50.03988771499381, 20.235872268676758]\n        ]\n    }\n}'"}]},"method":"put"},"next":{"description":"","pages":[]},"title":"Geofences: Update One","type":"endpoint","slug":"geofences-update-one","excerpt":"Update the parameters of a single geofence.","body":"","updates":[],"order":42,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28dc","__v":6,"category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"editedParams":true,"project":"54aa7f773b56130b0056c86e","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"createdAt":"2016-07-15T16:30:32.178Z","githubsync":"","user":"577cf7765fd4de0e00cc3d50","editedParams2":true,"parentDoc":null}

putGeofences: Update One

Update the parameters of a single geofence.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.
id:
required
string
Geofence ID. It can be fetched by "Geofences: Get All (Index)" endpoint.

Body Params

geofence:
required
object
Geofences to be created
geofence.name:
string
Name of geofence
geofence.location:
array_float
Location of the geofence as [latitude, longitude]
geofence.type:
string
Type of the geofence, can be one of: ["enter", "exit"]
geofence.shape:
string
polygonal or radial (optional)
geofence.radius:
string
Radius of the circle geofence in meters
geofence.path:
array_float
Path of the polygon geofence, as array of [latitude, longitude]

Examples


Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}