Contest lite

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

Create engaging sweepstakes using Antavo’s Contest lite module, offering customers to spend their points for a chance to win prizes, similar to lottery tickets.

Running a contest is a cost-effective way to reduce the number of unspent points in a loyalty program, as customers will redeem their points for the chance to win a prize – not directly for the prize itself.

All configured settings are accessible via Display API so that you can implement your own design on the customer-facing membership site. The Display API also provides the activities/{contest_id}/enter and activities/{contest_id}/revoke endpoints to enter and remove customers from contests.

Read the user manual page to learn about the Participate in a contest and Remove from contest workflow nodes to run a contest-based workflow or campaign.
This specific use case explains the scenario where you can reward customers with multiple contest entries.

 

Find the configuration page of the module by searching for ‘Contest lite’ item under the Modules menu. The page will open displaying the contests already set up with the following information:

  • Name of the contest
    The status of the contest is displayed under the name of the contest which reflects the progress and availability.

    • Active – currently ongoing and accepting entries

    • Inactive – the contest has not been activated or a platform user has deactivated it

    • Completed – the contest has been completed and winners have been selected

    • Scheduled – the start date of the contest is configured as a future date

  • Start date of the contest

  • End date of the contest

The default sorting order of the contests in the list is as follows:

  1. Start date of the contest
    The contest with the earliest start date is at the top of the list.

  2. End date of the contest
    In case multiple contests have the same start date, the one that ends sooner is placed higher on the list.

  3. Name of the contest
    In case multiple contests have the same start and end date, the contests are ordered alphabetically by their names.

Creating a new contest

To create a new contest, click the ‘Create new contest’ button in the sidebar of the Contest lite module page or click the 'Create’ button in the top-right corner.

Basic information

  • Enter the title of the contest

  • Upload an image for the contest

  • Write the description of the contest

  • Enter the Terms & Conditions of the contest
    The Terms & Conditions should contain all the legal details about the rules for participation.

  • Add the completion text
    This text may appear after the contest has ended.

Mechanics

  • Set the start and end dates of your contest

  • Define the date until the contest should be visible
    If this date is later than the end date, the Display API that lists the available contests for each customer will indicate that the progression of the contest is completed.

  • Select the segment(s) for which you’d like to make the contest available
    The Display API will include the contest in the list with ‘restricted' status to customers outside of the selected segment(s).

  • Refine the segment-based contest participation using the 'Restrict winner selection to the segment' checkbox
    This option is only available if you have selected segment(s) in the previous step. It is set to false by default.
    When enabled, customers who are no longer in the specific segment(s) by the time of winner selection will be removed from the winner selection pool. This means that they cannot be selected as winners.

  • Write a restriction message that tells customers why there are not able to enter the contest
    In case you have restricted the contest to specific segment(s), we suggest entering a general message that may cover both time- and segment-related limitations.

  • Specify the number of points the customers will spend to enter the contest
    The price you set here applies to one entry.

  • Set the number of times a customer can enter the contest

  • Set the number of winners of the contest

Winner selection method

In the last section of the module configuration page, you can choose how you would like to draw winners for your contest. Here are the options:

  • Select randomly from all customers
    Winners will be selected from the pool of all entrants, randomly, without any prioritization.

  • Select randomly from the top X customers
    Winners will be selected from customers with the most entries, randomly.

  • Customers with the most entry points
    The customer(s) with the highest number of points spent to enter will win.

Points economy

If your brand uses Multi-accounts, select here the account from which the entry points should be deducted.

  • Click ‘Create’ to save the contest

Activating the contest

After saving for the first time, the status of the contest is ‘inactive’, which means it appears only in the list of contests on the module configuration page.

You can activate the contest right away using the ‘Set active’ button on the upper right-hand side of the setup page and confirm the activation in the dialog that subsequently appears.

Managing contests

Edit a contest

Contests can be edited until the end date of the contest.

  • Navigate to the Contest lite module configuration page

  • Click on the ‘Edit’ button of the specific contest’s hamburger menu on the module configuration screen

  • Edit your contest

  • Save your changes by clicking the ‘Save’ button

Copy the contest ID

When looking up a contest in workflows you need to enter the ID of the contest. By clicking the ‘Copy ID’ button of the contest of the specific contest’s hamburger menu, the ID will be copied to the clipboard so that you can paste it in the ‘Lookup value’ field when configuring the ‘Entity lookup’ workflow node.

Select winners

Once a contest ends, you can select winners using the winner selection method you chose when creating the contest.

  • Navigate to the Contest lite module configuration page

  • Click the ‘Winner selection' button of the finished contest’s hamburger menu on the module configuration screen

You’ll see a list of customers who participated in the contest, along with the previously selected set of winners (if applicable).

Please note that the list includes every customer who participated in the contest. However, the winner selection mechanism will exclude customers who are no longer eligible to participate based on the segment restriction settings applied when the winners are selected.

  • Click the ‘Select winners’ button on the upper right-hand side of the page
    The name of the winner will appear immediately under the ‘Selected winners' section.

You can draw winners in a contest an unlimited number of times using the ‘Draw again’ button.

Close the contest

To ensure that no one overwrites the results of the winner selection, you should close every contest.

  • Go to the Contest lite module configuration page

  • Navigate to the contest’s Winner Selection screen

  • Click the ‘Close the contest’ button

  • Confirm your choice in the dialog that appears

Deactivate a contest

You can deactivate an inactive contest through the following steps:

  • Navigate to the Contest lite module configuration page

  • Click the ‘Edit’ button of the contest’s hamburger menu you want to deactivate

  • Click the ‘Set inactive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

Inactive contests are not returned by the activities/contests Display API endpoint.

Archive a contest

You have the option to delete the inactive contests from the Backoffice by archiving them.

  • Go to the Contest lite module page

  • Click on the contest you want to archive

  • Inactivate the contest

  • Click on the ‘Archive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

Archiving is irreversible. Once a contest is archived, it cannot be restored anymore. 

 

© Copyright 2022 Antavo Ltd.