{"_id":"543c87b6ea519d0800c91166","version":{"_id":"543c845ee443e3080085b330","project":"543c845ee443e3080085b32d","__v":6,"createdAt":"2014-10-14T02:03:10.835Z","releaseDate":"2014-10-14T02:03:10.835Z","categories":["543c845ee443e3080085b331","543c8794ea519d0800c91164","543d2918a22ffb0800a7af90","543d5da831ca981a00a6fead","543ecfc115d0560800502706","546165ea92398320003c7c79"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","is_link":false,"category":{"_id":"543c845ee443e3080085b331","__v":2,"pages":["543c845ee443e3080085b333","543c87b6ea519d0800c91166","546165ef92398320003c7c7a"],"project":"543c845ee443e3080085b32d","version":"543c845ee443e3080085b330","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-14T02:03:10.849Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"project":"543c845ee443e3080085b32d","__v":61,"user":"543c844ae443e3080085b32b","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-14T02:17:26.056Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","try":true,"basic_auth":false,"results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"This documentation has been depreciated.\",\n  \"body\": \"Please visit [http://vs.elevio.help/](http://vs.elevio.help/) for our updated documentation.\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"Skip to a section:\\n<br>\\n<a href=\\\"#full\\\">Full Page</a>\\n/\\n<a href=\\\"#widget\\\">Widget</a>\\n/\\n<a href=\\\"#lightbox\\\">Lightbox</a>\\n/\\n<a href=\\\"#popup\\\">Popup</a>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"full\\\"></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Full Page\"\n}\n[/block]\nThe full page acts as a landing page that takes over your entire screen. You'll want to place this on its own separate page, rather than trying to embed it within a current page on your website (however, you can do so if you have the technical knowledge). \n\nThe full page is the highest converting format that we offer, with conversion rates on average between 35-50%.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Full Page Demo\",\n  \"body\": \"View a demo of the full page in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/full/)\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/opMkEw4RKGjuSNeiaLDs_formats-full.jpg\",\n        \"formats-full.jpg\",\n        \"750\",\n        \"375\",\n        \"#82a739\",\n        \"\"\n      ],\n      \"caption\": \"The full page\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"widget\\\"></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Widget\"\n}\n[/block]\nThe widget is extremely versatile, allowing you to place it on any page, inside of blog posts, and even on a Facebook page tab.\n\nIn addition, the widget style is the second highest converting format that we offer, with conversion rates on average between 25-45%.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Widget Demo\",\n  \"body\": \"View a demo of the widget in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/widget/)\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ZZ1ntJhWRYmEGxDqh2zx_formats-widget.jpg\",\n        \"formats-widget.jpg\",\n        \"750\",\n        \"500\",\n        \"#9fa42b\",\n        \"\"\n      ],\n      \"caption\": \"Widget entry form and success page\"\n    }\n  ]\n}\n[/block]\nHere is the code for the widget. When you build your own campaign, your code will look almost the same. Feel free to use the code below if you are testing out an integration and want to see how the widget functions.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"NOTE\",\n  \"body\": \"The code below is to be used for testing purposes only. This is a demo campaign setup through ViralSweep. You can get the code for your own campaign in your ViralSweep dashboard.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script type=\\\"text/javascript\\\">\\nvar cnt_id = \\\"037f7fbf-7453\\\";\\n</script>\\n<script type=\\\"text/javascript\\\" src=\\\"https://www.viralsweep.com/external/widget.js\\\"></script>\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"lightbox\\\"></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Lightbox\"\n}\n[/block]\nThe lightbox places your giveaway on top of your website content to entice visitors to enter. \n\nBy default, the lightbox will display over the page content when a user visits the page you place it on. You can also trigger the lightbox to display when someone clicks on something.\n\nThe lightbox uses cookies, so once a user sees it, they won't see it again, unless they view your page from a different browser or they clear their cookies.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Lightbox Demo\",\n  \"body\": \"View a demo of the lightbox in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/lightbox)\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/iA6d0PBdRKWUn7rtYNUH_formats-lightbox.jpg\",\n        \"formats-lightbox.jpg\",\n        \"750\",\n        \"375\",\n        \"#6a7d09\",\n        \"\"\n      ],\n      \"caption\": \"Lightbox\"\n    }\n  ]\n}\n[/block]\nIn order to trigger the lightbox to popup when the user clicks a button or image, use the following code above your lightbox code:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<a href=\\\"javascript:void(0)\\\" onclick=\\\"vs_lightbox_on()\\\"><img src=\\\"[link to image here]\\\"></a>\\n\\n<script>\\nvs_lightbox_start_off = true;\\n</script>\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nBe sure to put the URL of an image in between the img src tag, and be sure to include your lightbox code from your ViralSweep dashboard below this code snippet. A completed and working version will look similar to this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<a href=\\\"javascript:void(0)\\\" onclick=\\\"vs_lightbox_on()\\\"><img src=\\\"http://viralsweep.com/images/lbbutton.png\\\"\\\"></a>\\n\\n<script>\\nvs_lightbox_start_off = true;\\n</script>\\n<script type=\\\"text/javascript\\\" src=\\\"https://www.viralsweep.com/lightbox-widget/wid-037f7fbf-7453.js\\\"></script>\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Lightbox Button Click Demo\",\n  \"body\": \"View a demo of the lightbox appearing after clicking a button: [http://www.viralsweep.com/demo/lightbox](http://www.viralsweep.com/demo/lightbox)\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<a name=\\\"popup\\\"></a>\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Popup\"\n}\n[/block]\nThe popup style pops up from the corner of your screen and can be placed on any or all pages of your website.\n\nBy default, the popup is set to show up from the bottom right corner of the screen when someone lands on your page. You can change the settings to have it display from the bottom left, top left, or top right, and you can even set it to remain minimized.\n\nThe popup uses cookies, so once it pops up for a user, it won't pop up again for them on repeat visits (it remains minimized).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Popup Demo\",\n  \"body\": \"View a demo of the popup in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/popup)\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/62h9QwFtRRSgmOJTi6HQ_formats-popup.jpg\",\n        \"formats-popup.jpg\",\n        \"750\",\n        \"375\",\n        \"#969535\",\n        \"\"\n      ],\n      \"caption\": \"The popup entry form and success page\"\n    }\n  ]\n}\n[/block]\nHere is the code for the popup. When you build your own campaign, your code will look almost the same. Feel free to use the code below if you are testing out an integration and want to see how the popup functions.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"NOTE\",\n  \"body\": \"The code below is to be used for testing purposes only. This is a demo campaign setup through ViralSweep. You can get the code for your own campaign in your ViralSweep dashboard.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script>var vs_widget_hide_on_mobile = false;</script>\\n<script src=\\\"https://www.viralsweep.com/widget/right-bottom-open/wid-7453-3526.js\\\" type=\\\"text/javascript\\\"></script>\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nIn the code above, you will see there are a few parameters that you can toggle. The first parameter is:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var vs_widget_hide_on_mobile = false;\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nThis is used to toggle the popup on or off on mobile devices. By default, it is set to false, so it will display on mobile. However, if you want to turn the popup off on mobile, simply change the value to true:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var vs_widget_hide_on_mobile = true;\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\nAnother parameter that you can toggle is the actual position of the popup on the screen. In between the URL, you will see 'right-bottom-open'. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://www.viralsweep.com/widget/right-bottom-open/wid-7453-3526.js\",\n      \"language\": \"coffeescript\"\n    }\n  ]\n}\n[/block]\nThe 'right' value can be changed to 'left' if you want to put it on the left side of the screen. \n\nThe 'bottom' value can be changed to 'top' if you want to put it on the top of the screen.\n\nThe 'open' value can be changed to 'closed' if you don't want it to popup on page load.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Any questions? We're here to help\",\n  \"body\": \"You can reach us at help:::at:::viralsweep.com or talk to us on live chat if we are available.\"\n}\n[/block]","excerpt":"ViralSweep currently offers four (4) different giveaway formats or styles that you can choose from to run your campaigns. Each format and its intended use is detailed below.","slug":"sweepstakes-styles","type":"basic","title":"Sweepstakes Styles"}

Sweepstakes Styles

ViralSweep currently offers four (4) different giveaway formats or styles that you can choose from to run your campaigns. Each format and its intended use is detailed below.

[block:callout] { "type": "danger", "title": "This documentation has been depreciated.", "body": "Please visit [http://vs.elevio.help/](http://vs.elevio.help/) for our updated documentation." } [/block] [block:html] { "html": "Skip to a section:\n<br>\n<a href=\"#full\">Full Page</a>\n/\n<a href=\"#widget\">Widget</a>\n/\n<a href=\"#lightbox\">Lightbox</a>\n/\n<a href=\"#popup\">Popup</a>" } [/block] [block:html] { "html": "<a name=\"full\"></a>" } [/block] [block:api-header] { "type": "basic", "title": "Full Page" } [/block] The full page acts as a landing page that takes over your entire screen. You'll want to place this on its own separate page, rather than trying to embed it within a current page on your website (however, you can do so if you have the technical knowledge). The full page is the highest converting format that we offer, with conversion rates on average between 35-50%. [block:callout] { "type": "info", "title": "Full Page Demo", "body": "View a demo of the full page in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/full/)" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/opMkEw4RKGjuSNeiaLDs_formats-full.jpg", "formats-full.jpg", "750", "375", "#82a739", "" ], "caption": "The full page" } ] } [/block] [block:html] { "html": "<a name=\"widget\"></a>" } [/block] [block:api-header] { "type": "basic", "title": "Widget" } [/block] The widget is extremely versatile, allowing you to place it on any page, inside of blog posts, and even on a Facebook page tab. In addition, the widget style is the second highest converting format that we offer, with conversion rates on average between 25-45%. [block:callout] { "type": "info", "title": "Widget Demo", "body": "View a demo of the widget in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/widget/)" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/ZZ1ntJhWRYmEGxDqh2zx_formats-widget.jpg", "formats-widget.jpg", "750", "500", "#9fa42b", "" ], "caption": "Widget entry form and success page" } ] } [/block] Here is the code for the widget. When you build your own campaign, your code will look almost the same. Feel free to use the code below if you are testing out an integration and want to see how the widget functions. [block:callout] { "type": "warning", "title": "NOTE", "body": "The code below is to be used for testing purposes only. This is a demo campaign setup through ViralSweep. You can get the code for your own campaign in your ViralSweep dashboard." } [/block] [block:code] { "codes": [ { "code": "<script type=\"text/javascript\">\nvar cnt_id = \"037f7fbf-7453\";\n</script>\n<script type=\"text/javascript\" src=\"https://www.viralsweep.com/external/widget.js\"></script>", "language": "javascript" } ] } [/block] [block:html] { "html": "<a name=\"lightbox\"></a>" } [/block] [block:api-header] { "type": "basic", "title": "Lightbox" } [/block] The lightbox places your giveaway on top of your website content to entice visitors to enter. By default, the lightbox will display over the page content when a user visits the page you place it on. You can also trigger the lightbox to display when someone clicks on something. The lightbox uses cookies, so once a user sees it, they won't see it again, unless they view your page from a different browser or they clear their cookies. [block:callout] { "type": "info", "title": "Lightbox Demo", "body": "View a demo of the lightbox in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/lightbox)" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/iA6d0PBdRKWUn7rtYNUH_formats-lightbox.jpg", "formats-lightbox.jpg", "750", "375", "#6a7d09", "" ], "caption": "Lightbox" } ] } [/block] In order to trigger the lightbox to popup when the user clicks a button or image, use the following code above your lightbox code: [block:code] { "codes": [ { "code": "<a href=\"javascript:void(0)\" onclick=\"vs_lightbox_on()\"><img src=\"[link to image here]\"></a>\n\n<script>\nvs_lightbox_start_off = true;\n</script>", "language": "javascript" } ] } [/block] Be sure to put the URL of an image in between the img src tag, and be sure to include your lightbox code from your ViralSweep dashboard below this code snippet. A completed and working version will look similar to this: [block:code] { "codes": [ { "code": "<a href=\"javascript:void(0)\" onclick=\"vs_lightbox_on()\"><img src=\"http://viralsweep.com/images/lbbutton.png\"\"></a>\n\n<script>\nvs_lightbox_start_off = true;\n</script>\n<script type=\"text/javascript\" src=\"https://www.viralsweep.com/lightbox-widget/wid-037f7fbf-7453.js\"></script>", "language": "javascript" } ] } [/block] [block:callout] { "type": "info", "title": "Lightbox Button Click Demo", "body": "View a demo of the lightbox appearing after clicking a button: [http://www.viralsweep.com/demo/lightbox](http://www.viralsweep.com/demo/lightbox)" } [/block] [block:html] { "html": "<a name=\"popup\"></a>" } [/block] [block:api-header] { "type": "basic", "title": "Popup" } [/block] The popup style pops up from the corner of your screen and can be placed on any or all pages of your website. By default, the popup is set to show up from the bottom right corner of the screen when someone lands on your page. You can change the settings to have it display from the bottom left, top left, or top right, and you can even set it to remain minimized. The popup uses cookies, so once it pops up for a user, it won't pop up again for them on repeat visits (it remains minimized). [block:callout] { "type": "info", "title": "Popup Demo", "body": "View a demo of the popup in action: [http://www.viralsweep.com/demo/](http://www.viralsweep.com/demo/jewelry/popup)" } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/62h9QwFtRRSgmOJTi6HQ_formats-popup.jpg", "formats-popup.jpg", "750", "375", "#969535", "" ], "caption": "The popup entry form and success page" } ] } [/block] Here is the code for the popup. When you build your own campaign, your code will look almost the same. Feel free to use the code below if you are testing out an integration and want to see how the popup functions. [block:callout] { "type": "warning", "title": "NOTE", "body": "The code below is to be used for testing purposes only. This is a demo campaign setup through ViralSweep. You can get the code for your own campaign in your ViralSweep dashboard." } [/block] [block:code] { "codes": [ { "code": "<script>var vs_widget_hide_on_mobile = false;</script>\n<script src=\"https://www.viralsweep.com/widget/right-bottom-open/wid-7453-3526.js\" type=\"text/javascript\"></script>", "language": "javascript" } ] } [/block] In the code above, you will see there are a few parameters that you can toggle. The first parameter is: [block:code] { "codes": [ { "code": "var vs_widget_hide_on_mobile = false;", "language": "javascript" } ] } [/block] This is used to toggle the popup on or off on mobile devices. By default, it is set to false, so it will display on mobile. However, if you want to turn the popup off on mobile, simply change the value to true: [block:code] { "codes": [ { "code": "var vs_widget_hide_on_mobile = true;", "language": "javascript" } ] } [/block] Another parameter that you can toggle is the actual position of the popup on the screen. In between the URL, you will see 'right-bottom-open'. [block:code] { "codes": [ { "code": "https://www.viralsweep.com/widget/right-bottom-open/wid-7453-3526.js", "language": "coffeescript" } ] } [/block] The 'right' value can be changed to 'left' if you want to put it on the left side of the screen. The 'bottom' value can be changed to 'top' if you want to put it on the top of the screen. The 'open' value can be changed to 'closed' if you don't want it to popup on page load. [block:callout] { "type": "info", "title": "Any questions? We're here to help", "body": "You can reach us at help@viralsweep.com or talk to us on live chat if we are available." } [/block]