{"_id":"55bb629874f10a0d002209aa","version":{"_id":"5540ce1c31827a0d007ab1cf","project":"5540ce1b31827a0d007ab1cc","__v":31,"createdAt":"2015-04-29T12:27:08.390Z","releaseDate":"2015-04-29T12:27:08.390Z","categories":["5540ce1c31827a0d007ab1d0","5540d91bbb9e762d00f594ad","5540e5f131827a0d007ab212","5540e5febb9e762d00f594d3","5540e61331827a0d007ab213","5540e6195cf9682100d61afa","5540e62631827a0d007ab214","5540e63031827a0d007ab215","5540e63531827a0d007ab216","5540e63e5cf9682100d61afc","5540e6445cf9682100d61afd","5540e64a5cf9682100d61afe","55a4ff5b2e70c0250038050f","55acb28318eefd0d0071d504","55ae1abe8576b92300291c80","55ae453ef302af23000ac109","55af586d555b900d0036d296","55af91dac8a85321007a53c3","55b9fee204775a2f00628071","55b9ff0e04775a2f00628072","55b9ff4604775a2f00628073","55b9ff5fd72d1e1900276a38","55b9ff7f04775a2f00628074","55b9ff90eb08801900f833e5","55b9ffa5d72d1e1900276a39","55b9ffca04775a2f00628075","55b9fffdd72d1e1900276a3a","56bc2f033ee9e70d008b46af","56c2f6efbbf9ec2d00e0fe4f","57595bbb18760817001e8bbe","57d8d9793916800e003dde53"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":4,"category":{"_id":"5540ce1c31827a0d007ab1d0","version":"5540ce1c31827a0d007ab1cf","pages":["5540ce1d31827a0d007ab1d2","5540ff9dbb9e762d00f59557","554109205cf9682100d61b65","554109c35cf9682100d61b6b","55a635b6249a40190051d9a2","55bb5de0a8400c2d00873e19","55bb5f4174f10a0d002209a2","55bb607374f10a0d002209a6","55bb614f7313650d00c46e88","55bb61d8a8400c2d00873e20","55bb629874f10a0d002209aa","55bb6318a8400c2d00873e23","55bb63a07313650d00c46e8a","55d5dc84988e130d000b4110","5620b53d40e2c30d0002a848","567cfe57221af70d00fc5498","567d01fd221af70d00fc549c"],"project":"5540ce1b31827a0d007ab1cc","__v":17,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-29T12:27:08.888Z","from_sync":false,"order":1,"slug":"remote-api","title":"Remote API"},"project":"5540ce1b31827a0d007ab1cc","user":"5540cdbf5cf9682100d61a97","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-31T11:57:12.062Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n   \"request\":{\n      \"application\":\"DEAD0-BEEF0\",\n      \"hwid\": \"device hardware id\",\n      \"badge\": 5\n      }  \n   }\n}","name":"JSON","language":"text"}]},"method":"post","results":{"codes":[{"status":200,"name":"","code":"{\n   \"status_code\":200,\n   \"status_message\":\"OK\"\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"58aaf7da8f862f250076faca","ref":"","in":"body","required":true,"desc":"Your Pushwoosh application ID","default":"","type":"string","name":"request.application"},{"_id":"58aaf7da8f862f250076fac9","ref":"","in":"body","required":true,"desc":"Hardware device id used in `/registerDevice` function call","default":"","type":"string","name":"request.hwid"},{"_id":"58aaf7da8f862f250076fac8","ref":"","in":"body","required":true,"desc":"Current badge on the application","default":"","type":"int","name":"request.badge"}],"url":"/setBadge"},"isReference":false,"order":11,"body":"Called from the SDK internally. Sends current badge value for a device to Pushwoosh. This happens internally when app changes badge value on iOS device. Allows auto-incrementing badges to work properly.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This method **IS NOT** used to update the badge value on the device. Instead please use `/createMessage` request with the `\\\"ios_badges\\\"` parameter.\",\n  \"title\": \"Important\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n//see http://gomoob.github.io/php-pushwoosh/set-badge.html\\nuse Gomoob\\\\Pushwoosh\\\\Model\\\\Request\\\\SetBadgeRequest;\\n\\n// Creates the request instance\\n$request = RegisterDeviceRequest::create()\\n    ->setBadge(5)\\n    ->setHwid('HWID');\\n\\n// Call the '/setBadge' Web Service\\n$response = $pushwoosh->setBadge($request);\\n\\nif($response->isOk()) {\\n    print 'Ok, operation successful.';\\n} else {\\n    print 'Oups, the operation failed :-('; \\n    print 'Status code : ' . $response->getStatusCode();\\n    print 'Status message : ' . $response->getStatusMessage();\\n}\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]","excerpt":"Sends current badge value for a device to Pushwoosh. Called internally from the SDK.","slug":"setbadge","type":"endpoint","title":"/setBadge"}

post/setBadge

Sends current badge value for a device to Pushwoosh. Called internally from the SDK.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

request.application:
required
string
Your Pushwoosh application ID
request.hwid:
required
string
Hardware device id used in `/registerDevice` function call
request.badge:
required
integer
Current badge on the application

Examples


Result Format


Documentation

Called from the SDK internally. Sends current badge value for a device to Pushwoosh. This happens internally when app changes badge value on iOS device. Allows auto-incrementing badges to work properly. [block:callout] { "type": "info", "body": "This method **IS NOT** used to update the badge value on the device. Instead please use `/createMessage` request with the `\"ios_badges\"` parameter.", "title": "Important" } [/block] [block:code] { "codes": [ { "code": "<?php\n//see http://gomoob.github.io/php-pushwoosh/set-badge.html\nuse Gomoob\\Pushwoosh\\Model\\Request\\SetBadgeRequest;\n\n// Creates the request instance\n$request = RegisterDeviceRequest::create()\n ->setBadge(5)\n ->setHwid('HWID');\n\n// Call the '/setBadge' Web Service\n$response = $pushwoosh->setBadge($request);\n\nif($response->isOk()) {\n print 'Ok, operation successful.';\n} else {\n print 'Oups, the operation failed :-('; \n print 'Status code : ' . $response->getStatusCode();\n print 'Status message : ' . $response->getStatusMessage();\n}", "language": "php" } ] } [/block]

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