API Reference
Inzendingen
Maak, haal op, werk bij en beheer wedstrijdinzendingen
Inzendingen
Beheer wedstrijddeelnemers en hun inzendingen.
Inzendingen Lijst
/api/v1/contests/:contestId/entriesGeeft een gepagineerde lijst van inzendingen voor een specifieke wedstrijd.
Padparameters
contestIdstring required De unieke wedstrijdidentificatie
Queryparameters
pagenumberPaginanummer, beginnend bij 1. Standaard: 1
limitnumberInzendingen per pagina (1-100). Standaard: 20
searchstringZoeken op e-mail of naam (niet hoofdlettergevoelig)
Verzoek
curl -X GET "https://blitzrocket.com/api/v1/contests/clx1abc123/entries?page=1&limit=10" \
-H "x-api-key: your_api_key_here"
Antwoord
{
"success": true,
"data": [
{
"id": "entry_abc123",
"email": "jane@example.com",
"name": "Jane Doe",
"phone": null,
"points": 150,
"emailConfirmed": true,
"disqualified": false,
"referralCode": "REF-XYZ789",
"createdAt": "2025-06-15T10:30:00.000Z"
},
{
"id": "entry_def456",
"email": "john@example.com",
"name": "John Smith",
"phone": "+1234567890",
"points": 85,
"emailConfirmed": true,
"disqualified": false,
"referralCode": "REF-ABC456",
"createdAt": "2025-06-16T14:20:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1523,
"totalPages": 153
}
}
Antwoordvelden
idstringUnieke identificatie voor de inzending
emailstringE-mailadres van de deelnemer
namestring | nullNaam van de deelnemer
phonestring | nullTelefoonnummer van de deelnemer
pointsnumberTotaal verdiende punten
emailConfirmedbooleanOf het e-mailadres bevestigd is
disqualifiedbooleanOf de inzending is gediskwalificeerd
referralCodestring | nullUnieke verwijzingscode voor deze inzending
createdAtstringISO 8601 tijdstempel wanneer de inzending is gemaakt
Haal Inzending Op
/api/v1/entries/:entryIdHaal gedetailleerde informatie op over een specifieke inzending.
Padparameters
entryIdstring required De unieke inzendingidentificatie
Verzoek
curl -X GET https://blitzrocket.com/api/v1/entries/entry_abc123 \
-H "x-api-key: your_api_key_here"
Antwoord
{
"success": true,
"data": {
"id": "entry_abc123",
"email": "jane@example.com",
"name": "Jane Doe",
"phone": null,
"points": 150,
"pointsUsed": 25,
"emailConfirmed": true,
"disqualified": false,
"referralCode": "REF-XYZ789",
"contestId": "clx1abc123def456",
"contestTitle": "Summer Giveaway 2025",
"referralsCount": 3,
"bonusActionsCompleted": 5,
"totalPurchaseValue": 129.99,
"totalPurchaseCount": 2,
"createdAt": "2025-06-15T10:30:00.000Z"
}
}
Maak Inzending Aan
/api/v1/contests/:contestId/entriesMaak een nieuwe inzending aan voor een wedstrijd. Vereist een private API-sleutel.
Padparameters
contestIdstring required De unieke wedstrijdidentificatie
Request Body
emailstringE-mailadres van de deelnemer. E-mail of telefoon is vereist.
phonestringTelefoonnummer van de deelnemer. E-mail of telefoon is vereist.
namestringNaam van de deelnemer (optioneel)
referralCodestringVerwijzingscode van een andere deelnemer (optioneel)
customFieldDataobjectObject met aangepaste veldgegevens (optioneel)
Request
curl -X POST https://blitzrocket.com/api/v1/contests/clx1abc123/entries \
-H "x-api-key: your_private_key_here" \
-H "Content-Type: application/json" \
-d '{
"email": "newuser@example.com",
"name": "New User",
"referralCode": "REF-XYZ789"
}'
Response (201 Created)
{
"success": true,
"data": {
"entryId": "entry_new789",
"email": "newuser@example.com",
"alreadyExists": false,
"isReferred": true,
"pointsAwarded": {
"advocate": 10,
"friend": 5
}
}
}
Als het e-mailadres al bestaat in de wedstrijd, zal de respons "alreadyExists": true bevatten met een status 200 OK.
Entry Bijwerken
/api/v1/entries/:entryIdWerk de informatie van een bestaande inschrijving bij. Ten minste één veld moet worden opgegeven.
Path Parameters
entryIdstring required De unieke inschrijvings-ID
Request Body
namestringBijgewerkte naam
emailstringBijgewerkt e-mailadres
phonestringBijgewerkt telefoonnummer
customFieldDataobjectBijgewerkte gegevens van aangepaste velden
Request
curl -X PUT https://blitzrocket.com/api/v1/entries/entry_abc123 \
-H "x-api-key: your_private_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Updated",
"phone": "+1987654321"
}'
Response
{
"success": true,
"data": {
"id": "entry_abc123",
"email": "jane@example.com",
"name": "Jane Updated",
"phone": "+1987654321",
"points": 150
}
}
Inschrijving Diskwalificeren
/api/v1/entries/:entryId/disqualifyDiskwalificeer of herkwalificeer een inschrijving.
Path Parameters
entryIdstring required De unieke inschrijvings-ID
Request Body
disqualifybooleanInstellen op true om te diskwalificeren, false om te herkvalificeren. Weglaten om te toggelen.
Verzoek
curl -X POST https://blitzrocket.com/api/v1/entries/entry_abc123/disqualify \
-H "x-api-key: your_private_key_here" \
-H "Content-Type: application/json" \
-d '{"disqualify": true}'
Reactie
{
"success": true,
"data": {
"entryId": "entry_abc123",
"disqualified": true,
"message": "Entry has been disqualified"
}
}
Punten Aanpassen
/api/v1/entries/:entryId/pointsVoeg punten toe of verwijder punten van een inzending. Punten kunnen niet onder nul komen.
Padparameters
entryIdstring required De unieke identificatie van de inzending
Verzoek Body
pointsnumber required Punten om toe te voegen (positief) of te verwijderen (negatief)
reasonstring required Reden voor de aanpassing
Verzoek
curl -X POST https://blitzrocket.com/api/v1/entries/entry_abc123/points \
-H "x-api-key: your_private_key_here" \
-H "Content-Type: application/json" \
-d '{
"points": 50,
"reason": "Bonus for completing survey"
}'
Reactie
{
"success": true,
"data": {
"message": "Successfully added 50 points",
"previousTotal": 150,
"newTotal": 200,
"adjustment": 50
}
}
Om punten te verwijderen, gebruik een negatieve waarde:
{
"points": -25,
"reason": "Penalty for rule violation"
}
Foutreacties
| Status | Fout | Beschrijving |
|---|---|---|
400 | Ontbrekende punten of reden | Beide velden zijn verplicht |
403 | Privésleutel vereist | Deze endpoint vereist een private API key |
404 | Inzending niet gevonden | Er bestaat geen inzending met de opgegeven ID |