Einträge

Verwalten Sie Wettbewerbsteilnehmer und deren Einträge.

Einträge auflisten

GET/api/v1/contests/:contestId/entries

Public or Private API Key

Gibt eine paginierte Liste von Einträgen für einen bestimmten Wettbewerb zurück.

Pfadparameter

contestIdstring required

Die eindeutige Wettbewerbs-ID

Abfrageparameter

pagenumber

Seitennummer, beginnend bei 1. Standard: 1

limitnumber

Einträge pro Seite (1-100). Standard: 20

searchstring

Suche nach E-Mail oder Name (Groß-/Kleinschreibung ignoriert)

Anfrage

bash

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

javascript

const contestId = "clx1abc123";
const params = new URLSearchParams({ page: "1", limit: "10" });

const response = await fetch(
  `https://blitzrocket.com/api/v1/contests/${contestId}/entries?${params}`,
  {
    headers: { "x-api-key": "your_api_key_here" },
  }
);

const { data, pagination } = await response.json();
console.log(`Seite ${pagination.page} von ${pagination.totalPages}`);
console.log(data);

python

import requests

contest_id = "clx1abc123"
response = requests.get(
    f"https://blitzrocket.com/api/v1/contests/{contest_id}/entries",
    headers={"x-api-key": "your_api_key_here"},
    params={"page": 1, "limit": 10}
)

result = response.json()
print(f"Seite {result['pagination']['page']} von {result['pagination']['totalPages']}")
print(result["data"])

Antwort

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
  }
}

Antwortfelder

idstring

Eindeutiger Bezeichner für den Eintrag

emailstring

E-Mail-Adresse des Teilnehmers

namestring | null

Name des Teilnehmers

phonestring | null

Telefonnummer des Teilnehmers

pointsnumber

Gesamtpunktzahl

emailConfirmedboolean

Ob die E-Mail bestätigt wurde

disqualifiedboolean

Ob der Eintrag disqualifiziert ist

referralCodestring | null

Eindeutiger Empfehlungs-Code für diesen Eintrag

createdAtstring

ISO 8601 Zeitstempel, wann der Eintrag erstellt wurde

Eintrag abrufen

GET/api/v1/entries/:entryId

Public or Private API Key

Detaillierte Informationen zu einem bestimmten Eintrag abrufen.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID

Anfrage

bash

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

javascript

const entryId = "entry_abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}`,
  {
    headers: { "x-api-key": "your_api_key_here" },
  }
);

const { data } = await response.json();
console.log(data);

python

import requests

entry_id = "entry_abc123"
response = requests.get(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()
print(data["data"])

Antwort

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"
  }
}

Eintrag erstellen

POST/api/v1/contests/:contestId/entries

Private API Key Required

Erstellen Sie einen neuen Eintrag für einen Wettbewerb. Erfordert einen privaten API-Schlüssel.

Pfadparameter

contestIdstring required

Die eindeutige Wettbewerbs-ID

Request Body

emailstring

E-Mail-Adresse des Teilnehmers. Entweder E-Mail oder Telefon ist erforderlich.

phonestring

Telefonnummer des Teilnehmers. Entweder E-Mail oder Telefon ist erforderlich.

namestring

Name des Teilnehmers (optional)

referralCodestring

Empfehlungscode von einem anderen Teilnehmer (optional)

customFieldDataobject

Objekt mit benutzerdefinierten Felddaten (optional)

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"
  }'

javascript

const contestId = "clx1abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/contests/${contestId}/entries`,
  {
    method: "POST",
    headers: {
      "x-api-key": "your_private_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      email: "newuser@example.com",
      name: "New User",
      referralCode: "REF-XYZ789",
    }),
  }
);

const { data } = await response.json();
console.log(data);

python

import requests

contest_id = "clx1abc123"
response = requests.post(
    f"https://blitzrocket.com/api/v1/contests/{contest_id}/entries",
    headers={
        "x-api-key": "your_private_key_here",
        "Content-Type": "application/json"
    },
    json={
        "email": "newuser@example.com",
        "name": "New User",
        "referralCode": "REF-XYZ789"
    }
)

data = response.json()
print(data["data"])

Response (201 Created)

json

{
  "success": true,
  "data": {
    "entryId": "entry_new789",
    "email": "newuser@example.com",
    "alreadyExists": false,
    "isReferred": true,
    "pointsAwarded": {
      "advocate": 10,
      "friend": 5
    }
  }
}

Wenn die E-Mail bereits im Wettbewerb existiert, enthält die Antwort "alreadyExists": true mit einem 200 OK Status.

Eintrag aktualisieren

PUT/api/v1/entries/:entryId

Private API Key Required

Aktualisieren Sie die Informationen eines bestehenden Eintrags. Mindestens ein Feld muss angegeben werden.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID

Request Body

namestring

Aktualisierter Name

emailstring

Aktualisierte E-Mail-Adresse

phonestring

Aktualisierte Telefonnummer

customFieldDataobject

Aktualisierte benutzerdefinierte Felddaten

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"
  }'

javascript

const entryId = "entry_abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}`,
  {
    method: "PUT",
    headers: {
      "x-api-key": "your_private_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Jane Updated",
      phone: "+1987654321",
    }),
  }
);

const { data } = await response.json();
console.log(data);

python

import requests

entry_id = "entry_abc123"
response = requests.put(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}",
    headers={
        "x-api-key": "your_private_key_here",
        "Content-Type": "application/json"
    },
    json={
        "name": "Jane Updated",
        "phone": "+1987654321"
    }
)

data = response.json()
print(data["data"])

Response

json

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

Eintrag disqualifizieren

POST/api/v1/entries/:entryId/disqualify

Private API Key Required

Eintrag disqualifizieren oder wieder qualifizieren.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID

Request Body

disqualifyboolean

Auf true setzen, um zu disqualifizieren, auf false, um wieder zu qualifizieren. Weglassen zum Umschalten.

Request

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}'

javascript

const entryId = "entry_abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}/disqualify`,
  {
    method: "POST",
    headers: {
      "x-api-key": "your_private_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ disqualify: true }),
  }
);

const { data } = await response.json();
console.log(data.message);
// => "Entry has been disqualified"

python

import requests

entry_id = "entry_abc123"
response = requests.post(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}/disqualify",
    headers={
        "x-api-key": "your_private_key_here",
        "Content-Type": "application/json"
    },
    json={"disqualify": True}
)

data = response.json()
print(data["data"]["message"])
# => "Entry has been disqualified"

Response

json

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

Punkte anpassen

POST/api/v1/entries/:entryId/points

Private API Key Required

Fügen Sie einem Eintrag Punkte hinzu oder entfernen Sie diese. Punkte können nicht unter Null fallen.

Pfadparameter

entryIdstring required

Die eindeutige Eintrags-ID

Anfragekörper

pointsnumber required

Punkte zum Hinzufügen (positiv) oder Entfernen (negativ)

reasonstring required

Grund für die Anpassung

Anfrage

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 für das Ausfüllen der Umfrage"
  }'

javascript

const entryId = "entry_abc123";
const response = await fetch(
  `https://blitzrocket.com/api/v1/entries/${entryId}/points`,
  {
    method: "POST",
    headers: {
      "x-api-key": "your_private_key_here",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      points: 50,
      reason: "Bonus für das Ausfüllen der Umfrage",
    }),
  }
);

const { data } = await response.json();
console.log(`Punkte: ${data.previousTotal} → ${data.newTotal}`);

python

import requests

entry_id = "entry_abc123"
response = requests.post(
    f"https://blitzrocket.com/api/v1/entries/{entry_id}/points",
    headers={
        "x-api-key": "your_private_key_here",
        "Content-Type": "application/json"
    },
    json={
        "points": 50,
        "reason": "Bonus für das Ausfüllen der Umfrage"
    }
)

data = response.json()
print(f"Punkte: {data['data']['previousTotal']} → {data['data']['newTotal']}")

Antwort

json

{
  "success": true,
  "data": {
    "message": "Erfolgreich 50 Punkte hinzugefügt",
    "previousTotal": 150,
    "newTotal": 200,
    "adjustment": 50
  }
}

Um Punkte zu entfernen, verwenden Sie einen negativen Wert:

json

{
  "points": -25,
  "reason": "Strafe wegen Regelverstoß"
}

Fehlerantworten

Status	Fehler	Beschreibung
`400`	Fehlende Punkte oder Grund	Beide Felder sind erforderlich
`403`	Privater Schlüssel erforderlich	Dieser Endpunkt erfordert einen privaten API-Schlüssel
`404`	Eintrag nicht gefunden	Kein Eintrag mit der angegebenen ID vorhanden