API Reference

Inzendingen

Maak, haal op, werk bij en beheer wedstrijdinzendingen

Inzendingen

Beheer wedstrijddeelnemers en hun inzendingen.


Inzendingen Lijst

GET/api/v1/contests/:contestId/entries
Public or Private API Key

Geeft een gepagineerde lijst van inzendingen voor een specifieke wedstrijd.

Padparameters

contestIdstring required

De unieke wedstrijdidentificatie

Queryparameters

pagenumber

Paginanummer, beginnend bij 1. Standaard: 1

limitnumber

Inzendingen per pagina (1-100). Standaard: 20

searchstring

Zoeken op e-mail of naam (niet hoofdlettergevoelig)

Verzoek

bash
curl -X GET "https://blitzrocket.com/api/v1/contests/clx1abc123/entries?page=1&limit=10" \
  -H "x-api-key: your_api_key_here"

Antwoord

json
{
  "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

idstring

Unieke identificatie voor de inzending

emailstring

E-mailadres van de deelnemer

namestring | null

Naam van de deelnemer

phonestring | null

Telefoonnummer van de deelnemer

pointsnumber

Totaal verdiende punten

emailConfirmedboolean

Of het e-mailadres bevestigd is

disqualifiedboolean

Of de inzending is gediskwalificeerd

referralCodestring | null

Unieke verwijzingscode voor deze inzending

createdAtstring

ISO 8601 tijdstempel wanneer de inzending is gemaakt


Haal Inzending Op

GET/api/v1/entries/:entryId
Public or Private API Key

Haal gedetailleerde informatie op over een specifieke inzending.

Padparameters

entryIdstring required

De unieke inzendingidentificatie

Verzoek

bash
curl -X GET https://blitzrocket.com/api/v1/entries/entry_abc123 \
  -H "x-api-key: your_api_key_here"

Antwoord

json
{
  "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

POST/api/v1/contests/:contestId/entries
Private API Key Required

Maak een nieuwe inzending aan voor een wedstrijd. Vereist een private API-sleutel.

Padparameters

contestIdstring required

De unieke wedstrijdidentificatie

Request Body

emailstring

E-mailadres van de deelnemer. E-mail of telefoon is vereist.

phonestring

Telefoonnummer van de deelnemer. E-mail of telefoon is vereist.

namestring

Naam van de deelnemer (optioneel)

referralCodestring

Verwijzingscode van een andere deelnemer (optioneel)

customFieldDataobject

Object met aangepaste veldgegevens (optioneel)

Request

bash
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)

json
{
  "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

PUT/api/v1/entries/:entryId
Private API Key Required

Werk de informatie van een bestaande inschrijving bij. Ten minste één veld moet worden opgegeven.

Path Parameters

entryIdstring required

De unieke inschrijvings-ID

Request Body

namestring

Bijgewerkte naam

emailstring

Bijgewerkt e-mailadres

phonestring

Bijgewerkt telefoonnummer

customFieldDataobject

Bijgewerkte gegevens van aangepaste velden

Request

bash
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

json
{
  "success": true,
  "data": {
    "id": "entry_abc123",
    "email": "jane@example.com",
    "name": "Jane Updated",
    "phone": "+1987654321",
    "points": 150
  }
}

Inschrijving Diskwalificeren

POST/api/v1/entries/:entryId/disqualify
Private API Key Required

Diskwalificeer of herkwalificeer een inschrijving.

Path Parameters

entryIdstring required

De unieke inschrijvings-ID

Request Body

disqualifyboolean

Instellen op true om te diskwalificeren, false om te herkvalificeren. Weglaten om te toggelen.

Verzoek

bash
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

json
{
  "success": true,
  "data": {
    "entryId": "entry_abc123",
    "disqualified": true,
    "message": "Entry has been disqualified"
  }
}

Punten Aanpassen

POST/api/v1/entries/:entryId/points
Private API Key Required

Voeg 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

bash
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

json
{
  "success": true,
  "data": {
    "message": "Successfully added 50 points",
    "previousTotal": 150,
    "newTotal": 200,
    "adjustment": 50
  }
}

Om punten te verwijderen, gebruik een negatieve waarde:

json
{
  "points": -25,
  "reason": "Penalty for rule violation"
}

Foutreacties

StatusFoutBeschrijving
400Ontbrekende punten of redenBeide velden zijn verplicht
403Privésleutel vereistDeze endpoint vereist een private API key
404Inzending niet gevondenEr bestaat geen inzending met de opgegeven ID