https://api.viralkit.com/api_endpoint/fetch-all-contests
GET
https://api.viralkit.com/api_endpoint/fetch-contest
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/create-contest
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
title | Plain text | Title of the contest | Yes |
start_date | YYYY-MM-DD HH:MM:SS | Start date and time of the contest (default value is today at midnight) | Optional |
end_date | YYYY-MM-DD HH:MM:SS | End date and time of the contest (default value is 30 days from not at 23:59:00) | Optional |
description | html | Description of the contest (use HTML tags) | Optional |
if_terms_and_conditions | true or false | Flag for terms and conditions (default value is false) | Optional |
https://api.viralkit.com/api_endpoint/update-contest
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
title | Plain text | Title of the contest | Yes |
start_date | YYYY-MM-DD HH:MM:SS | Start date and time of the contest (default value is today at midnight) | Optional |
end_date | YYYY-MM-DD HH:MM:SS | End date and time of the contest (default value is 30 days from not at 23:59:00) | Optional |
description | html | Description of the contest (use HTML tags) | Optional |
https://api.viralkit.com/api_endpoint/delete-contest
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/fetch-all-contest-users
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/fetch-all-contest-entries
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/fetch-user-entries
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
user_email | Plain text | Email of the user | Yes |
https://api.viralkit.com/api_endpoint/add-user
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
user_name | Plain text | Full name of the user | Yes |
user_email | Plain text | Email address of the user | Yes |
entry_amount | Number | Number of entries for this user | Yes |
photo_url | Plain text | URL to the photo of the user | Optional |
birthday_day | DD | Birth day of user in 2 number format | Optional |
birthday_month | MM | Birth day of user in 2 number format | Optional |
birthday_year | YYYY | Birth day of user in 4 number format | Optional |
country_code | 2 letter country code | Country code of the user | Optional |
region | Plain text | Region of the user | Optional |
referred_by | Plain text | Email address of the participant who referred this user (you must have a Refer A Friend entry method on this contest for this to work) | Optional |
https://api.viralkit.com/api_endpoint/delete-user
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
user_email | Plain text | Email address of the user | Yes |
https://api.viralkit.com/api_endpoint/delete-single-entry
POST
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/fetch-all-winners
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
https://api.viralkit.com/api_endpoint/add-new-entry-method
GET
Name | Accepted Values | Description | Required |
---|---|---|---|
contests_id | Plain text | ID of your contest | Yes |
field_name | Plain text | The name of the field, e.g., 'Instagram Follow Profile'. Here is a list of all the field names | Yes |
field_header | Plain text | The header of the field, displayed to users | Yes |
question | Boolean | Indicates if the field is a question | No |
instructions | Plain text | Instructions for the field, if any | No |
options | JSON/Array | Additional options for the field | No |
required_value | Plain text | The required answer if validation is needed | No |
entry_url | URL | URL for the entry method | No |
entry_amount | Number | The amount of entries this method will generate | No |
button_text | Plain text | Text on the submission button | No |
if_daily | Boolean | Determines if the entry method can be performed daily | No |
daily | Number | Number of daily entries allowed | No |
required | Boolean | Indicates if the field is required | No |
require_validation | Boolean | Indicates if the field requires validation | No |
validation_question | Plain text | Question prompted for validation | No |
form_field | Boolean | Indicates if this is a form field | No |
api_verification | Boolean | Determines if API verification is needed | No |
icon | CSS class | FontAwesome CSS class for the icon e.g. 'fa-instagram' | Yes |
icon_color | Color (hex) | Hex color code for the icon | Yes |
icon_background_color | Color (hex) | Hex background color code for the icon | Yes |
curl -X GET https://api.viralkit.com/api_endpoint/fetch-all-contests
-H 'Authorization: Bearer YOUR_API_KEY'
{
"success": true,
"response": [
{
"contests_id": "a1h27f89",
"title": "$100 Amazon Gift Card Giveaway",
"More fields..."
}
]
}