{"_id":"58aad9de8f862f250076fa28","project":"54aa7f773b56130b0056c86e","user":"577cf7765fd4de0e00cc3d50","version":{"_id":"58aad9dd8f862f250076f9f4","project":"54aa7f773b56130b0056c86e","__v":2,"createdAt":"2017-02-20T11:58:21.765Z","releaseDate":"2017-02-20T11:58:21.765Z","categories":["58aad9dd8f862f250076f9f5","58aad9dd8f862f250076f9f6","58aad9dd8f862f250076f9f7","58aad9dd8f862f250076f9f8","58aad9dd8f862f250076f9f9","58aad9dd8f862f250076f9fa","58aad9dd8f862f250076f9fb","58ac26b3d460ce2500185d26"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Locate","version_clean":"6.0.0","version":"6.0"},"parentDoc":null,"__v":0,"category":{"_id":"58aad9dd8f862f250076f9f6","version":"58aad9dd8f862f250076f9f4","project":"54aa7f773b56130b0056c86e","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":2,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-15T16:30:32.178Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"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}"}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","code":"curl -H 'Authorization: Token token=\"my_admin_api_token\"' https://control.pulsatehq.com/api/v1/geofences/:geofenceid"}]},"method":"put","auth":"required","params":[{"_id":"57ff8265c135231700aed828","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"app_id"},{"_id":"57890fa87a572c0e0011fd1c","ref":"","in":"path","required":true,"desc":"Geofence Id to update","default":"","type":"string","name":"id"},{"_id":"58764a95b5092c1900586edc","ref":"","in":"body","required":true,"desc":"Geofences to be created","default":"","type":"array_object","name":"geofences"},{"_id":"57890fa87a572c0e0011fd1b","ref":"","in":"body","required":false,"desc":"Name of geofence","default":"","type":"string","name":"geofences.name"},{"_id":"57890fa87a572c0e0011fd1a","ref":"","in":"body","required":false,"desc":"Location of the geofence as [latitude, longitude]","default":"","type":"array_float","name":"geofences.location"},{"_id":"57890fa87a572c0e0011fd18","ref":"","in":"body","required":false,"desc":"Type of the geofence, can be one of: [\"enter\", \"exit\"]","default":"","type":"string","name":"geofences.type"},{"_id":"57890fa87a572c0e0011fd17","ref":"","in":"body","required":false,"desc":"polygonal or radial (optional)","default":"","type":"string","name":"geofences.shape"},{"_id":"57890fa87a572c0e0011fd16","ref":"","in":"body","required":false,"desc":"Radius of the circle geofence in meters","default":"","type":"string","name":"geofences.radius"},{"_id":"57890fa87a572c0e0011fd15","ref":"","in":"body","required":false,"desc":"Path of the polygon geofence, as array of [latitude, longitude]","default":"","type":"array_float","name":"geofences.path"}],"url":"/apps/:app_id/geofences/:id"},"isReference":true,"order":18,"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
id:
required
string
Geofence Id to update

Body Params

geofences:
required
array of objects
Geofences to be created
geofences.name:
string
Name of geofence
geofences.location:
array_float
Location of the geofence as [latitude, longitude]
geofences.type:
string
Type of the geofence, can be one of: ["enter", "exit"]
geofences.shape:
string
polygonal or radial (optional)
geofences.radius:
string
Radius of the circle geofence in meters
geofences.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 }}