{"_id":"57890fa87a572c0e0011fd13","__v":6,"category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"editedParams":true,"project":"54aa7f773b56130b0056c86e","version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"githubsync":"","user":"577cf7765fd4de0e00cc3d50","editedParams2":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-15T16:30:32.178Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","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}","language":"json"}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"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}'","language":"shell"}]},"method":"put","auth":"required","params":[{"_id":"57ff8265c135231700aed828","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"},{"_id":"57890fa87a572c0e0011fd1c","ref":"","in":"path","required":true,"desc":"Geofence ID. It can be fetched by \"Geofences: Get All (Index)\" endpoint.","default":"","type":"string","name":"id"},{"_id":"58764a95b5092c1900586edc","ref":"","in":"body","required":true,"desc":"Geofences to be created","default":"","type":"object","name":"geofence"},{"_id":"57890fa87a572c0e0011fd1b","ref":"","in":"body","required":false,"desc":"Name of geofence","default":"","type":"string","name":"geofence.name"},{"_id":"57890fa87a572c0e0011fd1a","ref":"","in":"body","required":false,"desc":"Location of the geofence as [latitude, longitude]","default":"","type":"array_float","name":"geofence.location"},{"_id":"57890fa87a572c0e0011fd18","ref":"","in":"body","required":false,"desc":"Type of the geofence, can be one of: [\"enter\", \"exit\"]","default":"","type":"string","name":"geofence.type"},{"_id":"57890fa87a572c0e0011fd17","ref":"","in":"body","required":false,"desc":"polygonal or radial (optional)","default":"","type":"string","name":"geofence.shape"},{"_id":"57890fa87a572c0e0011fd16","ref":"","in":"body","required":false,"desc":"Radius of the circle geofence in meters","default":"","type":"string","name":"geofence.radius"},{"_id":"57890fa87a572c0e0011fd15","ref":"","in":"body","required":false,"desc":"Path of the polygon geofence, as array of [latitude, longitude]","default":"","type":"array_float","name":"geofence.path"}],"url":"/apps/:app_id/geofences/:id"},"isReference":true,"order":39,"body":"","excerpt":"Update the parameters of a single geofence.","slug":"geofences-update-one","type":"endpoint","title":"Geofences: Update One"}

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 }}