Inscriptions

Gérez les participants au concours et leurs inscriptions.

Lister les Inscriptions

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

Public or Private API Key

Renvoie une liste paginée des inscriptions pour un concours spécifique.

Paramètres de chemin

contestIdstring required

L'identifiant unique du concours

Paramètres de requête

pagenumber

Numéro de page, à partir de 1. Par défaut : 1

limitnumber

Inscriptions par page (1-100). Par défaut : 20

searchstring

Recherche par email ou nom (insensible à la casse)

Requête

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(`Page ${pagination.page} sur ${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"Page {result['pagination']['page']} sur {result['pagination']['totalPages']}")
print(result["data"])

Réponse

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

Champs de réponse

idstring

Identifiant unique de l'inscription

emailstring

Adresse email du participant

namestring | null

Nom du participant

phonestring | null

Numéro de téléphone du participant

pointsnumber

Total des points gagnés

emailConfirmedboolean

Indique si l'email a été confirmé

disqualifiedboolean

Indique si l'inscription est disqualifiée

referralCodestring | null

Code de parrainage unique pour cette inscription

createdAtstring

Horodatage ISO 8601 de la création de l'inscription

Obtenir une Inscription

GET/api/v1/entries/:entryId

Public or Private API Key

Récupérez les informations détaillées sur une inscription spécifique.

Paramètres de chemin

entryIdstring required

L'identifiant unique de l'inscription

Requête

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"])

Réponse

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

Créer une Inscription

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

Private API Key Required

Créez une nouvelle inscription pour un concours. Une clé API privée est requise.

Paramètres de chemin

contestIdstring required

L'identifiant unique du concours

Corps de la requête

emailstring

Adresse e-mail du participant. Soit l'email soit le téléphone est requis.

phonestring

Numéro de téléphone du participant. Soit l'email soit le téléphone est requis.

namestring

Nom du participant (optionnel)

referralCodestring

Code de parrainage d'un autre participant (optionnel)

customFieldDataobject

Objet des données de champ personnalisé (optionnel)

Requête

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"])

Réponse (201 Créé)

json

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

Si l'email existe déjà dans le concours, la réponse inclura "alreadyExists": true avec un statut 200 OK.

Mettre à jour une participation

PUT/api/v1/entries/:entryId

Private API Key Required

Mettre à jour les informations d'une participation existante. Au moins un champ doit être fourni.

Paramètres de chemin

entryIdstring required

L'identifiant unique de la participation

Corps de la requête

namestring

Nom mis à jour

emailstring

Adresse e-mail mise à jour

phonestring

Numéro de téléphone mis à jour

customFieldDataobject

Données de champ personnalisé mises à jour

Requête

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"])

Réponse

json

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

Disqualifier une participation

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

Private API Key Required

Disqualifier ou requalifier une participation.

Paramètres de chemin

entryIdstring required

L'identifiant unique de la participation

Corps de la requête

disqualifyboolean

Mettre à true pour disqualifier, false pour requalifier. Omettre pour basculer.

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

Ajuster les points

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

Private API Key Required

Ajouter ou retirer des points à une participation. Les points ne peuvent pas descendre en dessous de zéro.

Paramètres de chemin

entryIdstring required

L'identifiant unique de la participation

Corps de la requête

pointsnumber required

Points à ajouter (positif) ou retirer (négatif)

reasonstring required

Motif de l'ajustement

Requête

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 pour avoir complété le sondage"
  }'

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 pour avoir complété le sondage",
    }),
  }
);

const { data } = await response.json();
console.log(`Points : ${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 pour avoir complété le sondage"
    }
)

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

Réponse

json

{
  "success": true,
  "data": {
    "message": "50 points ajoutés avec succès",
    "previousTotal": 150,
    "newTotal": 200,
    "adjustment": 50
  }
}

Pour retirer des points, utilisez une valeur négative :

json

{
  "points": -25,
  "reason": "Pénalité pour violation des règles"
}

Réponses d'erreur

Statut	Erreur	Description
`400`	Points ou motif manquant	Les deux champs sont obligatoires
`403`	Clé privée requise	Ce point d'accès nécessite une clé API privée
`404`	Participation non trouvée	Aucune participation avec l'ID donné n'existe