{"_id":"564c3a7b61008d17006ffa3a","parentDoc":null,"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"},"editedParams":true,"user":"54aa7f3f9bb00c0b00cb899b","githubsync":"","project":"54aa7f773b56130b0056c86e","__v":4,"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"},"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-18T08:44:43.478Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"guid\": \"3ixWCPxf\",\n  \"name\": \"sample_geofence_name\",\n  \"path\": [\n    [\n      50.042754135466986,\n      20.207290649414062\n    ],\n    [\n      50.02334733167384,\n      20.200166702270508\n    ],\n    [\n      50.02433991532921,\n      20.235872268676758\n    ],\n    [\n      50.03988771499381,\n      20.235872268676758\n    ]\n  ],\n  \"radius\": 101,\n  \"shape\": \"polygon\",\n  \"type\": \"enter\",\n  \"location\": [\n    50.042754135466986,\n    20.207290649414062\n  ],\n  \"id\": \"58762461636f6e3a0c7d0300\"\n}","language":"json","status":200}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"name":"","code":"curl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/geofences/\"\n  -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n      \"geofence\": {\n          \"name\": \"sample_geofence_name\",\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":"post","auth":"required","params":[{"_id":"564c387b9baa330d00faa623","ref":"","in":"body","required":true,"desc":"Geofence to be inserted","default":"{}","type":"object","name":"geofence"},{"_id":"57ff8232e7218a1900673d08","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":"58764a1a36358c0f004bde40","ref":"","in":"body","required":false,"desc":"Name of geofence","default":"","type":"string","name":"geofence.name"},{"_id":"58764a1a36358c0f004bde3f","ref":"","in":"body","required":false,"desc":"Location of the geofence as [latitude, longitude]","default":"","type":"array_float","name":"geofence.location"},{"_id":"58764a1a36358c0f004bde3e","ref":"","in":"body","required":false,"desc":"Type of the geofence, can be one of: [\"enter\", \"exit\"]","default":"","type":"string","name":"geofence.type"},{"_id":"58764a1a36358c0f004bde3d","ref":"","in":"body","required":false,"desc":"Type of geofence, can be one of [\"circle\", \"polygon\"]","default":"","type":"string","name":"geofence.shape"},{"_id":"58764a1a36358c0f004bde3c","ref":"","in":"body","required":false,"desc":"Radius of the circle geofence in meters","default":"","type":"string","name":"geofence.radius"},{"_id":"58764a1a36358c0f004bde3b","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"},"isReference":true,"order":37,"body":"","excerpt":"","slug":"geofences-create-one","type":"endpoint","title":"Geofences: Create One"}

postGeofences: Create One


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.

Body Params

geofence:
required
object{}
Geofence to be inserted
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
Type of geofence, can be one of ["circle", "polygon"]
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

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