{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/geofences","auth":"required","results":{"codes":[{"status":200,"language":"json","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}","name":""}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"language":"shell","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  }'","name":""}]},"method":"post","params":[{"name":"geofence","type":"object","default":"{}","desc":"Geofence to be inserted","required":true,"in":"body","ref":"","_id":"564c387b9baa330d00faa623"},{"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":"57ff8232e7218a1900673d08"},{"name":"geofence.name","type":"string","default":"","desc":"Name of geofence","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde40"},{"name":"geofence.location","type":"array_float","default":"","desc":"Location of the geofence as [latitude, longitude]","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde3f"},{"name":"geofence.type","type":"string","default":"","desc":"Type of the geofence, can be one of: [\"enter\", \"exit\"]","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde3e"},{"name":"geofence.shape","type":"string","default":"","desc":"Type of geofence, can be one of [\"circle\", \"polygon\"]","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde3d"},{"name":"geofence.radius","type":"string","default":"","desc":"Radius of the circle geofence in meters","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde3c"},{"name":"geofence.path","type":"array_float","default":"","desc":"Path of the polygon geofence, as array of [latitude, longitude]","required":false,"in":"body","ref":"","_id":"58764a1a36358c0f004bde3b"}]},"next":{"description":"","pages":[]},"title":"Geofences: Create One","type":"endpoint","slug":"geofences-create-one","excerpt":"","body":"","updates":[],"order":41,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28c9","parentDoc":null,"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"},"editedParams":true,"user":"54aa7f3f9bb00c0b00cb899b","createdAt":"2015-11-18T08:44:43.478Z","githubsync":"","project":"54aa7f773b56130b0056c86e","__v":4,"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"},"editedParams2":true}

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