{"id":"542b6018044e1e2200413772","name":"OneSignal Push Notification Service Documentation","subdomain":"gamethrive","versions":[{"_id":"542b6018044e1e2200413775","releaseDate":"2014-10-01T01:59:52.301Z","is_deprecated":true,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1.0"},{"_id":"5446f40fbeb6320800da6ec8","releaseDate":"2014-10-22T00:02:23.562Z","is_deprecated":false,"is_hidden":true,"is_beta":false,"is_stable":false,"codename":"","version_clean":null,"version":""},{"_id":"551ef4ef4986f62b00a7202e","releaseDate":"2015-04-03T20:15:43.149Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},{"_id":"573a8dcf7f35072900c851de","releaseDate":"2016-05-17T03:19:43.708Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"","version_clean":"2.1.0","version":"2.1"}],"doc_slug":"","current_version":{"version_clean":"2.0.0","version":"2.0"},"oauth":{"enabled":false},"api":{"name":"","url":"https://onesignal.com/api/v1","contenttype":"json","auth":"basic","explorer":false,"jwt":null,"authextra":null,"headers":null,"object_definitions":[]},"apiAlt":[],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"themebuilder":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true,"apps":true},"apps":{"enabled":false},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"ssl":true},"asset_base_url":""}

{"__v":15,"_id":"56c2761847394f0d00e2285e","category":{"__v":4,"_id":"551ef4ef4986f62b00a72038","pages":["551ef4f04986f62b00a7205d","551ef4f04986f62b00a7205e","551ef4f04986f62b00a7205f","551ef4f04986f62b00a72060","551ef4f04986f62b00a72061","551ef4f04986f62b00a72062","551ef4f04986f62b00a72063","551ef4f04986f62b00a72064","551ef4f04986f62b00a72065","551ef4f04986f62b00a72066","551ef4f04986f62b00a72067","551ef4f04986f62b00a72068","551ef4f04986f62b00a72069","551ef4f04986f62b00a7206a","551ef4f04986f62b00a7206b","551ef4f04986f62b00a7206c","5523150ae20da719000e78c2","5641731cb0dc090d00f88398","56c2761847394f0d00e2285e"],"project":"542b6018044e1e2200413772","version":"551ef4ef4986f62b00a7202e","reference":false,"createdAt":"2014-10-22T01:34:57.891Z","from_sync":false,"order":16,"slug":"server-rest-api","title":"Server REST API"},"parentDoc":null,"project":"542b6018044e1e2200413772","user":"542b6010044e1e220041376f","version":{"__v":7,"_id":"551ef4ef4986f62b00a7202e","forked_from":"542b6018044e1e2200413775","project":"542b6018044e1e2200413772","createdAt":"2015-04-03T20:15:43.149Z","releaseDate":"2015-04-03T20:15:43.149Z","categories":["551ef4ef4986f62b00a7202f","551ef4ef4986f62b00a72030","551ef4ef4986f62b00a72031","551ef4ef4986f62b00a72032","551ef4ef4986f62b00a72033","551ef4ef4986f62b00a72034","551ef4ef4986f62b00a72035","551ef4ef4986f62b00a72036","551ef4ef4986f62b00a72037","551ef4ef4986f62b00a72038","551ef4ef4986f62b00a72039","551ef4ef4986f62b00a7203a","551ef4ef4986f62b00a7203b","551ef4ef4986f62b00a7203c","551ef4ef4986f62b00a7203d","551ef4ef4986f62b00a7203e","55d7f1879510f00d007ec727","56b94a5a9fc0de1700b60ae9","56bd0e48ac1c5c1900b2dbe4","56d74afc3eb4dd0b0020196a","5723ab8a1f41110e003081ed","576b4dd327d6252b00085422"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"createdAt":"2016-02-16T01:06:32.016Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Want to be notified of updates to this page? You can use [https://visualping.io](https://visualping.io).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"June 6, 2016\"\n}\n[/block]\nThe players/csv_export API will now compress the output file in GZip format.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"June 1, 2016\"\n}\n[/block]\nDeprecated `android_background_data`\n  * This will continue working however you should migrate to using our `NotificationExtenderService` by following our [Background Data and Notification Overriding](https://documentation.onesignal.com/docs/android-notification-customizations#background-data-and-notification-overriding) instructions which no longer requires this flag.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"April 4, 2016\"\n}\n[/block]\nCreating and deleting queued notifications through the OneSignal API will now return the value 'True' (boolean) for the \"success\" JSON attribute. Previously these endpoints would return \"true\" (string) for this attribute.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"March 11, 2016\"\n}\n[/block]\nThe amount_spent field on GET players and GET players/:id will now be returned as a number with two decimal places (dollars and cents), instead of as a string.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"March 9, 2016\"\n}\n[/block]\nUpcoming API Change:\n\nWe will soon begin deleting notifications sent through the OneSignal API that were delivered over 30 days ago.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"March 3, 2016\"\n}\n[/block]\nA client reported that an HTTP 400 status code was being returned when creating a notification with tag targeting and when no recipients were subscribed.\n\nWe've corrected this issue to return an HTTP 200 status code to match up with the behavior of using other targeting fields when no recipients are subscribed.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Feb 26, 2016\"\n}\n[/block]\nDelivering a notification to a list of OneSignal IDs or Tokens when all targeted devices are unsubscribed has had it's status code changed based on user feedback. This endpoint will now always return HTTP 200 status code even when all recipients are unsubscribed. Previously this case would return an HTTP 204 status code.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Feb 12, 2016\"\n}\n[/block]\nDelivering a notification to a list of OneSignal IDs or Tokens when all targeted devices are unsubscribed will now return an HTTP 204 status code. Previously this returned a 400 HTTP status code. The format of the response has also changed. The new format is ```{'id': \"\", 'recipients': 0, 'errors': [\"All included players are not subscribed\"]}```","excerpt":"","slug":"api-changelog","type":"basic","title":"API Changelog"}

API Changelog

Want to be notified of updates to this page? You can use [https://visualping.io](https://visualping.io). [block:api-header] { "type": "basic", "title": "June 6, 2016" } [/block] The players/csv_export API will now compress the output file in GZip format. [block:api-header] { "type": "basic", "title": "June 1, 2016" } [/block] Deprecated `android_background_data` * This will continue working however you should migrate to using our `NotificationExtenderService` by following our [Background Data and Notification Overriding](https://documentation.onesignal.com/docs/android-notification-customizations#background-data-and-notification-overriding) instructions which no longer requires this flag. [block:api-header] { "type": "basic", "title": "April 4, 2016" } [/block] Creating and deleting queued notifications through the OneSignal API will now return the value 'True' (boolean) for the "success" JSON attribute. Previously these endpoints would return "true" (string) for this attribute. [block:api-header] { "type": "basic", "title": "March 11, 2016" } [/block] The amount_spent field on GET players and GET players/:id will now be returned as a number with two decimal places (dollars and cents), instead of as a string. [block:api-header] { "type": "basic", "title": "March 9, 2016" } [/block] Upcoming API Change: We will soon begin deleting notifications sent through the OneSignal API that were delivered over 30 days ago. [block:api-header] { "type": "basic", "title": "March 3, 2016" } [/block] A client reported that an HTTP 400 status code was being returned when creating a notification with tag targeting and when no recipients were subscribed. We've corrected this issue to return an HTTP 200 status code to match up with the behavior of using other targeting fields when no recipients are subscribed. [block:api-header] { "type": "basic", "title": "Feb 26, 2016" } [/block] Delivering a notification to a list of OneSignal IDs or Tokens when all targeted devices are unsubscribed has had it's status code changed based on user feedback. This endpoint will now always return HTTP 200 status code even when all recipients are unsubscribed. Previously this case would return an HTTP 204 status code. [block:api-header] { "type": "basic", "title": "Feb 12, 2016" } [/block] Delivering a notification to a list of OneSignal IDs or Tokens when all targeted devices are unsubscribed will now return an HTTP 204 status code. Previously this returned a 400 HTTP status code. The format of the response has also changed. The new format is ```{'id': "", 'recipients': 0, 'errors': ["All included players are not subscribed"]}```