{"_id":"58aad9de8f862f250076fa36","__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"},"parentDoc":null,"user":"57a45e5726785a0e00b69a49","project":"54aa7f773b56130b0056c86e","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-05T13:16:51.739Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"battery\": \"Check\",\n  \"beacon_id\": \"new_beacon_id\",\n  \"major\": 456,\n  \"minor\": 123,\n  \"nickname\": \"new_beacon_nickname\",\n  \"uuid\": \"99999999-9999-9999-9999-999999999994\",\n  \"id\": \"57a48f67636f6eb757a03100\",\n  \"beacon_events_count\": 0\n}"},{"status":401,"language":"text","code":"HTTP Token: Access denied."}]},"settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"code":"curl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/beacons/\" \\\n-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\" \\\n-d '{\n    \"beacon\": {\n        \"beacon_id\": \"new_beacon_id\",\n        \"nickname\": \"new_beacon_nickname\",\n        \"uuid\": \"99999999-9999-9999-9999-999999999996\",\n        \"major\": 456,\n        \"minor\": 123\n    }\n}'","language":"shell"}]},"method":"post","auth":"required","params":[{"_id":"57ff844cc135231700aed82f","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"app_id"},{"_id":"58776dd0b8e8fb1900608ed4","ref":"","in":"body","required":true,"desc":"Beacon to be created","default":"","type":"object","name":"beacon"},{"_id":"57a491c326785a0e00b69ae8","ref":"","in":"body","required":true,"desc":"Beacon beacon_id","default":"","type":"string","name":"beacon.beacon_id"},{"_id":"57a491c326785a0e00b69ae7","ref":"","in":"body","required":true,"desc":"Beacon nickname","default":"","type":"string","name":"beacon.nickname"},{"_id":"57a491c326785a0e00b69ae6","ref":"","in":"body","required":true,"desc":"Beacon UUID","default":"","type":"string","name":"beacon.uuid"},{"_id":"57a491c326785a0e00b69ae5","ref":"","in":"body","required":true,"desc":"Beacon major","default":"","type":"int","name":"beacon.major"},{"_id":"57a491c326785a0e00b69ae4","ref":"","in":"body","required":true,"desc":"Beacon minor","default":"","type":"int","name":"beacon.minor"}],"url":"/apps/:app_id/beacons/"},"isReference":true,"order":32,"body":"","excerpt":"","slug":"beacons-create-one","type":"endpoint","title":"Beacons: Create One"}

postBeacons: Create One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string

Body Params

beacon:
required
object
Beacon to be created
beacon.beacon_id:
required
string
Beacon beacon_id
beacon.nickname:
required
string
Beacon nickname
beacon.uuid:
required
string
Beacon UUID
beacon.major:
required
integer
Beacon major
beacon.minor:
required
integer
Beacon minor

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