{"_id":"54a1f0af50465f1f00bfa3e8","version":{"_id":"542998547a6b690800768071","__v":9,"project":"542998547a6b69080076806e","createdAt":"2014-09-29T17:35:16.249Z","releaseDate":"2014-09-29T17:35:16.249Z","categories":["542998547a6b690800768072","5433027990d63b1c0030c0f1","5433028190d63b1c0030c0f2","5433028d9a2b451a00ad4508","5433055790d63b1c0030c10a","5461417d37e5bc200049e1e4","54624066ddd31b0800a58db4","54625de66d1f1010002f3901","54d309955616470d0013cc55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":3,"parentDoc":null,"project":"542998547a6b69080076806e","user":"542998207a6b690800768069","category":{"_id":"542998547a6b690800768072","version":"542998547a6b690800768071","pages":["542a3de5e677b0080050898f","544e8298de6bac1000236fe9","542998547a6b690800768074","542ab90154d88d140075fbd4","5433300867f20a080097a04b","5433302067f20a080097a04d","544e7ae6de6bac1000236fb5","54330b4990d63b1c0030c129","543da24b31ca981a00a6ffe7","54333238a807e208003e72d2","544e8305bd51b9080037f9cb","54332b234aeeef0800410a73","5433306067f20a080097a051","543db19f31ca981a00a70053","543d31d6a10ab32000b3aa70","54a1f0af50465f1f00bfa3e8","54cfc5925ff7e617002bbda5","54f4f09158e9df0d00917b3e"],"project":"542998547a6b69080076806e","__v":22,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-29T17:35:16.267Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-30T00:24:15.891Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"In December 2014 we've launched the Promo Tool, which you can use to generate activity and purchases, by incentivizing the entire system or specific activities.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Promo Examples\",\n  \"body\": \"* Users get 10% extra points for all transactions this month\\n* Users get 25% extra points on all Bitcoin payments this month\\n* Users in Germany get a 10% discount on all purchases\\n* Users get 1 extra point on all offers they complete\"\n}\n[/block]\nPromos are created using the Promo Tool in your [Dashboard](https://pub.superrewards.com/login).  Look for **Promo Tool** in the menu.\n\nYou'll see a list of any promos that you have created, and a button to **Add New Promotion**.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9Buza9upTraNzum5GcXg_Screenshot%202014-12-29%2016.48.18.png\",\n        \"Screenshot 2014-12-29 16.48.18.png\",\n        \"772\",\n        \"314\",\n        \"#5d8742\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Creating a Promotion\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Planned for the future\",\n  \"body\": \"Because you create promotions with a start time and end time, you can enter them now for events in the future, and they will start and stop automatically.  You do not need to turn them on and off yourself.\"\n}\n[/block]\nHere is an example of the promo create form.  Below you will find step-by-step instructions for each field.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/mHNWRYHaQO6DFFRv36Nj_Screenshot%202014-12-29%2011.55.12.png\",\n        \"Screenshot 2014-12-29 11.55.12.png\",\n        \"772\",\n        \"506\",\n        \"#5c8040\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n1. **Promotion Name**: This is a private name for this promotion that you will see in the list.  This is not shown to users.\n2. **Apps**: You can select whether this promotion applies to all of your apps, or only to one app.\n3. **Time Zone**: The time zone to use for the start and end times.\n4. **Start Date**: The date and time to enable the promotion.  When this time is reached (using the Time Zone you chose), then the users will see the promotion on the wall, and it will be applied to transactions.\n5. **End Date**: The date and time to stop the promotion.  When this time is reached (using the Time Zone you chose), then users will not see the promo any more, and it will not apply to any transactions after that.  You will see it in the **Disabled Promotions** list in your dashboard, so you can turn it back on again if you need to.\n6. **Promotion Bonus**: The type and amount of your promotion.  This is explained in more detail below, under **Promotion Calculation**.\n7. **Offer Wall Message**: This text is shown to users to explain the promotion.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Make It Exciting!\",\n  \"body\": \"The **Offer Wall Message** is your chance to get the users excited about the promotion while it is live.  For example:\\n\\\"Happy New Year!  As a gift to our users, all purchases in January get 25% extra coins!\\\"\\nor\\n\\\"GOAL! To celebrate German's World Cup Win, all users in Germany get 10% off on coin purchases this week!\\\"\\n\\nThe text you enter will only be shown to users who qualify (eg. the second example would only be seen by users coming from Germany).\\n\\nYou can also use limited HTML tags in the description text to enhance it:\\n<b> <u> <p> <a> <h1> <h2> <h3> <img> are all supported.\"\n}\n[/block]\nHere's an example of how the promotion is displayed, with formatted description and a countdown until the end time (shown automatically)\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/NIDsimYwTuJUN6YcZqge_Screenshot%202014-12-22%2015.07.10.png\",\n        \"Screenshot 2014-12-22 15.07.10.png\",\n        \"921\",\n        \"202\",\n        \"#27a9c3\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Advanced Options\"\n}\n[/block]\nThere is a button at the bottom of the form to open up advanced options:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/zhNrf3t9S5iCW05jq7nD_Screenshot%202014-12-29%2012.48.11.png\",\n        \"Screenshot 2014-12-29 12.48.11.png\",\n        \"464\",\n        \"240\",\n        \"#a3664b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n* **Country**: Limit the promotion to a single country, or \"All\" countries.\n* ** Payment Methods**: Your promotion can apply to all transactions, to payments only, to offers only, or to a custom filter.\n\nIf you choose Custom Filters, you can select what payment methods you want to be active for the promo, and you can search for and select Offers to include as well.  In this example we searched for \"vista\" and included a VistaPrint offer for the promotion.  Using this tool you can promote a single offer if you like.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/jgaSuWlKTBWwDqa86kOs_Screenshot%202014-12-29%2012.49.46.png\",\n        \"Screenshot 2014-12-29 12.49.46.png\",\n        \"569\",\n        \"246\",\n        \"#769c3b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Promotion Calculations\"\n}\n[/block]\nThere are three formats for promotions:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/DCVpZAoZQeyksVFvILAT_Screenshot%202014-12-29%2016.50.28.png\",\n        \"Screenshot 2014-12-29 16.50.28.png\",\n        \"497\",\n        \"82\",\n        \"#9b7258\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n**Price Discount Percent**\nDeduct a percentage from the amount paid for any payment purchase.  For example, setting this option, and the *Amount* to \"10\" will reduce the price of any purchase by 10%.  This option does not apply to Offers, as they do not have a price.\n\n**Percent Bonus**\nAdds free points (virtual currency) to the payout received by a user, by calculating a percent.  For example, setting this option, and the *Amount* to \"10\" will give 10% more points to a user above the normal amount.\n\n**Flat Bonus**\nAdds free points (virtual currency) to the payout received by the user, by adding this amount on directly.  For example, setting this option, and the *Amount* to \"10\" will give 10 extra points to a user above the normal amount.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Price (original)\",\n    \"1-0\": \"Point Payout (original)\",\n    \"0-1\": \"$5.00\",\n    \"1-1\": \"500\",\n    \"0-2\": \"$5.00\",\n    \"1-2\": \"500\",\n    \"h-1\": \"Discount Percent\",\n    \"h-2\": \"Percent Bonus\",\n    \"h-3\": \"Flat Bonus\",\n    \"0-3\": \"$5.00\",\n    \"1-3\": \"500\",\n    \"2-0\": \"Promo Amount Setting\",\n    \"2-1\": \"10\",\n    \"2-2\": \"10\",\n    \"2-3\": \"10\",\n    \"3-0\": \"New Price\",\n    \"3-1\": \"$4.50\",\n    \"3-2\": \"$5.00\",\n    \"3-3\": \"$5.00\",\n    \"4-0\": \"Free Points\",\n    \"4-1\": \"0\",\n    \"4-2\": \"50\",\n    \"4-3\": \"10\",\n    \"5-0\": \"New Points Awarded\",\n    \"5-1\": \"500\",\n    \"5-2\": \"550\",\n    \"5-3\": \"510\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]","excerpt":"The Promo Tool allows you to run promotions or sales","slug":"running-promotions","type":"basic","title":"Running Promotions"}

Running Promotions

The Promo Tool allows you to run promotions or sales

In December 2014 we've launched the Promo Tool, which you can use to generate activity and purchases, by incentivizing the entire system or specific activities. [block:callout] { "type": "info", "title": "Promo Examples", "body": "* Users get 10% extra points for all transactions this month\n* Users get 25% extra points on all Bitcoin payments this month\n* Users in Germany get a 10% discount on all purchases\n* Users get 1 extra point on all offers they complete" } [/block] Promos are created using the Promo Tool in your [Dashboard](https://pub.superrewards.com/login). Look for **Promo Tool** in the menu. You'll see a list of any promos that you have created, and a button to **Add New Promotion**. [block:image] { "images": [ { "image": [ "https://files.readme.io/9Buza9upTraNzum5GcXg_Screenshot%202014-12-29%2016.48.18.png", "Screenshot 2014-12-29 16.48.18.png", "772", "314", "#5d8742", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Creating a Promotion" } [/block] [block:callout] { "type": "success", "title": "Planned for the future", "body": "Because you create promotions with a start time and end time, you can enter them now for events in the future, and they will start and stop automatically. You do not need to turn them on and off yourself." } [/block] Here is an example of the promo create form. Below you will find step-by-step instructions for each field. [block:image] { "images": [ { "image": [ "https://files.readme.io/mHNWRYHaQO6DFFRv36Nj_Screenshot%202014-12-29%2011.55.12.png", "Screenshot 2014-12-29 11.55.12.png", "772", "506", "#5c8040", "" ] } ] } [/block] 1. **Promotion Name**: This is a private name for this promotion that you will see in the list. This is not shown to users. 2. **Apps**: You can select whether this promotion applies to all of your apps, or only to one app. 3. **Time Zone**: The time zone to use for the start and end times. 4. **Start Date**: The date and time to enable the promotion. When this time is reached (using the Time Zone you chose), then the users will see the promotion on the wall, and it will be applied to transactions. 5. **End Date**: The date and time to stop the promotion. When this time is reached (using the Time Zone you chose), then users will not see the promo any more, and it will not apply to any transactions after that. You will see it in the **Disabled Promotions** list in your dashboard, so you can turn it back on again if you need to. 6. **Promotion Bonus**: The type and amount of your promotion. This is explained in more detail below, under **Promotion Calculation**. 7. **Offer Wall Message**: This text is shown to users to explain the promotion. [block:callout] { "type": "info", "title": "Make It Exciting!", "body": "The **Offer Wall Message** is your chance to get the users excited about the promotion while it is live. For example:\n\"Happy New Year! As a gift to our users, all purchases in January get 25% extra coins!\"\nor\n\"GOAL! To celebrate German's World Cup Win, all users in Germany get 10% off on coin purchases this week!\"\n\nThe text you enter will only be shown to users who qualify (eg. the second example would only be seen by users coming from Germany).\n\nYou can also use limited HTML tags in the description text to enhance it:\n<b> <u> <p> <a> <h1> <h2> <h3> <img> are all supported." } [/block] Here's an example of how the promotion is displayed, with formatted description and a countdown until the end time (shown automatically) [block:image] { "images": [ { "image": [ "https://files.readme.io/NIDsimYwTuJUN6YcZqge_Screenshot%202014-12-22%2015.07.10.png", "Screenshot 2014-12-22 15.07.10.png", "921", "202", "#27a9c3", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Advanced Options" } [/block] There is a button at the bottom of the form to open up advanced options: [block:image] { "images": [ { "image": [ "https://files.readme.io/zhNrf3t9S5iCW05jq7nD_Screenshot%202014-12-29%2012.48.11.png", "Screenshot 2014-12-29 12.48.11.png", "464", "240", "#a3664b", "" ] } ] } [/block] * **Country**: Limit the promotion to a single country, or "All" countries. * ** Payment Methods**: Your promotion can apply to all transactions, to payments only, to offers only, or to a custom filter. If you choose Custom Filters, you can select what payment methods you want to be active for the promo, and you can search for and select Offers to include as well. In this example we searched for "vista" and included a VistaPrint offer for the promotion. Using this tool you can promote a single offer if you like. [block:image] { "images": [ { "image": [ "https://files.readme.io/jgaSuWlKTBWwDqa86kOs_Screenshot%202014-12-29%2012.49.46.png", "Screenshot 2014-12-29 12.49.46.png", "569", "246", "#769c3b", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Promotion Calculations" } [/block] There are three formats for promotions: [block:image] { "images": [ { "image": [ "https://files.readme.io/DCVpZAoZQeyksVFvILAT_Screenshot%202014-12-29%2016.50.28.png", "Screenshot 2014-12-29 16.50.28.png", "497", "82", "#9b7258", "" ] } ] } [/block] **Price Discount Percent** Deduct a percentage from the amount paid for any payment purchase. For example, setting this option, and the *Amount* to "10" will reduce the price of any purchase by 10%. This option does not apply to Offers, as they do not have a price. **Percent Bonus** Adds free points (virtual currency) to the payout received by a user, by calculating a percent. For example, setting this option, and the *Amount* to "10" will give 10% more points to a user above the normal amount. **Flat Bonus** Adds free points (virtual currency) to the payout received by the user, by adding this amount on directly. For example, setting this option, and the *Amount* to "10" will give 10 extra points to a user above the normal amount. [block:parameters] { "data": { "0-0": "Price (original)", "1-0": "Point Payout (original)", "0-1": "$5.00", "1-1": "500", "0-2": "$5.00", "1-2": "500", "h-1": "Discount Percent", "h-2": "Percent Bonus", "h-3": "Flat Bonus", "0-3": "$5.00", "1-3": "500", "2-0": "Promo Amount Setting", "2-1": "10", "2-2": "10", "2-3": "10", "3-0": "New Price", "3-1": "$4.50", "3-2": "$5.00", "3-3": "$5.00", "4-0": "Free Points", "4-1": "0", "4-2": "50", "4-3": "10", "5-0": "New Points Awarded", "5-1": "500", "5-2": "550", "5-3": "510" }, "cols": 4, "rows": 6 } [/block]