KickoffLabs is a great platform for collecting leads and running viral contests. We make it easy to setup refer a friend style contests, giveaways, sweepstakes, and product launches.
You can build out amazing marketing experiences with our script platform and developer APIs. We have some best practices outlines here that teach you how based on your goals.
In most cases, we recommend using the AnyForm widget for custom pages instead of adding leads directly via the API
In this case you just want to add a little bit of flair beyond what what you can control in our designer.
Read our complete guide to this here. You may not need to develop your own page or use our API directly.
Ex: Using the custom HTML block.
We get it. No landing page template does your brand justice. You are a designer or developer that likes to write their own HTML and connect that page and form to a contest platform like ours. You may already have a site built or have purchased a template you want to use instead.
That’s where AnyForm comes in. KickoffLabs AnyForm is a script turns any custom HTML form into a KickoffLabs form. The process looks like this:
In most cases people choose to use a KickoffLabs hosted page like https://thanks.YourWebSiteDomainHere.com.
Click here to learn how to generate the AnyForm Script for your campaign.
90% of the time this is what you probably want to do if you are here. If you need something more custom then keep reading below about our API.
The AnyForm Script ready to install.
When a lead signs up we can make an HTTP Post to the URLs you specify for your campaign. The body of the post will have all of the parameters specified in our API documentation here.
Learn how to setup WebHook targets for your campaign. You may not need to develop your own page or use our API directly.
It's also possible to use the KickoffLabs API directly. You can add leads to your campaign, check a leads status to build your own reward pages, and tag leads as well to assign custom points for your contest.
To use the API you'll need to make sure it's enabled for your campaign, you know the campaign ID, and you are using an API key. To get this:
Read below for API endpoints.
You need the campaign ID and API key.
To add an email to your customer list, you need to make an HttpPost to the following end point:
https://api.kickofflabs.com/v1/{YOUR CAMPAIGN ID}/subscribe
Supplying these values will help us better categorize your leads and prevent fraudelent/spam leads from adversely affecting your campaign.
This is useful to simply pull information about an existing subscriber.
To retrieve subscriber information from your customer list, you need to make Get request to the following end point:
https://api.kickofflabs.com/v1/{YOUR CAMPAIGN ID}/info
You must include only 1 of the following parameters
You can also optionally include an api_key parameter (found in your KickoffLabs dashboard). When this is present, the response will include a users custom fields.
NOTE: While recommend using an HttpPost, since we also support JSONP, you can also add subscriptions via HttpGet
The response body is JSON and will contain parameters:
You can also include a query string parameter jsonp. When this is present (HttpGet only) we will wrap the JSON response with the name of the callback. This is generally used to integrate our API directly into a web page wit JavaScript.
Keep on reading to find examples from Ruby to VB.NET. :) We also have a complete demo you can download.
Please keep in mind that if you are building a custom form you should probably be using AnyForm. This is for example purposes only.