Leads

Lister, rechercher, créer (upsert), modifier et supprimer vos leads.

Un lead est un contact capté par vos tunnels, votre site ou votre propre code. Il porte ses coordonnées, son canal de relance préféré, son statut commercial et des traits libres que vous pouvez utiliser dans vos segments.

L'objet lead

Champ Type Description
id uuid Identifiant STRIKE du lead.
first_name string Prénom.
email string | null Adresse email, en minuscules.
phone_number string | null Numéro au format international (+229…).
country_code string Code pays ISO à 2 lettres.
preferred_channel string whatsapp, email ou sms.
status string cold, warm, converted ou blacklisted.
funnel_id uuid | null Tunnel qui a capté le lead.
traits object Attributs libres (plan, ville, source…).
unsubscribed boolean Vrai si le lead s’est désinscrit des relances.
unsubscribed_at datetime | null Date de désinscription des relances.
created_at datetime Date de création (ISO 8601, UTC).
updated_at datetime | null Dernière modification.

Lister les leads

GET /api/platform/v1/leads leads:read

Retourne les leads du compte, du plus récent au plus ancien. Tous les filtres sont combinables.

Paramètres de requête

Champ Type Description
status string cold, warm, converted ou blacklisted.
email string Correspondance exacte (insensible à la casse).
phone_number string Correspondance exacte, format international.
funnel_id uuid Leads captés par ce tunnel.
created_after datetime Créés à partir de cette date (ISO 8601).
created_before datetime Créés avant cette date (ISO 8601).
q string Recherche plein texte sur le prénom, l’email et le téléphone.
limit integer Nombre d’éléments par page, de 1 à 100. Par défaut 25.
cursor string Valeur next_cursor de la page précédente. Voir Pagination.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/leads?status=warm&limit=10' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads?status=warm&limit=10', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/leads",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    params={
        "status": "warm",
        "limit": 10,
    },
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads?status=warm&limit=10');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "list",
  "data": [
    {
      "object": "lead",
      "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
      "first_name": "Awa",
      "email": "awa@exemple.com",
      "phone_number": "+22997000000",
      "country_code": "BJ",
      "preferred_channel": "whatsapp",
      "status": "warm",
      "funnel_id": "3c59dc04-8f1e-4b6a-9d2c-1e5f7a9b0c21",
      "traits": {
        "plan": "pro",
        "city": "Cotonou"
      },
      "unsubscribed": false,
      "unsubscribed_at": null,
      "created_at": "2026-10-14T09:12:31.000Z",
      "updated_at": "2026-10-15T16:02:11.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "MjAyNi0xMC0xNFQwOToxMjozMS4wMDBafDhmMTRlNDVm"
}

Erreurs spécifiques

422 Paramètre invalide (invalid_request) ; param indique le champ en cause.

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Équivalent pour les agents IA : l'outil MCP search_leads.

Récupérer un lead

GET /api/platform/v1/leads/:id leads:read

Retourne un lead par son identifiant.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du lead.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "lead",
  "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
  "first_name": "Awa",
  "email": "awa@exemple.com",
  "phone_number": "+22997000000",
  "country_code": "BJ",
  "preferred_channel": "whatsapp",
  "status": "warm",
  "funnel_id": "3c59dc04-8f1e-4b6a-9d2c-1e5f7a9b0c21",
  "traits": {
    "plan": "pro",
    "city": "Cotonou"
  },
  "unsubscribed": false,
  "unsubscribed_at": null,
  "created_at": "2026-10-14T09:12:31.000Z",
  "updated_at": "2026-10-15T16:02:11.000Z"
}

Erreurs spécifiques

404 Lead introuvable, ou appartenant à un autre compte (not_found).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Équivalent pour les agents IA : l'outil MCP get_lead.

Créer ou mettre à jour un lead

POST /api/platform/v1/leads leads:write

Crée un lead, ou met à jour le lead existant qui a le même email ou le même numéro (upsert). Un nouveau lead répond 201 avec "created": true ; un lead existant répond 200 avec "created": false. Sur un lead existant, le prénom, le pays, le canal et le statut envoyés sont mis à jour, l’email et le téléphone ne sont complétés que s’ils étaient vides, et les traits sont fusionnés. Un lead créé entre dans votre quota mensuel. Émet lead.created ou lead.updated.

Corps de la requête (JSON)

Champ Type Description
email string Email valide. email ou phone_number est requis.
phone_number string Format international E.164, par exemple +22997000000.
first_name string Prénom, 1 à 100 caractères. Par défaut, la partie de l’email avant « @ ».
country_code string Code ISO à 2 lettres. Par défaut BJ.
preferred_channel string whatsapp, email ou sms, inclus dans votre offre. Par défaut : email si le lead n’a qu’un email, sinon le canal habituel du pays.
status string cold (défaut), warm, converted ou blacklisted.
funnel_id uuid Tunnel d’origine (doit appartenir à votre compte).
traits object Attributs libres, fusionnés avec les traits existants (16 Ko max.).

Exemple de requête

curl -X POST 'https://strikespace.net/api/platform/v1/leads' \
  -H "Authorization: Bearer $STRIKE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "first_name": "Awa",
    "email": "awa@exemple.com",
    "phone_number": "+22997000000",
    "country_code": "BJ",
    "preferred_channel": "whatsapp",
    "traits": {
      "plan": "pro",
      "city": "Cotonou"
    }
  }'
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    "first_name": "Awa",
    "email": "awa@exemple.com",
    "phone_number": "+22997000000",
    "country_code": "BJ",
    "preferred_channel": "whatsapp",
    "traits": {
      "plan": "pro",
      "city": "Cotonou"
    }
  }),
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import uuid
import requests

response = requests.post(
    "https://strikespace.net/api/platform/v1/leads",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
        "first_name": "Awa",
        "email": "awa@exemple.com",
        "phone_number": "+22997000000",
        "country_code": "BJ",
        "preferred_channel": "whatsapp",
        "traits": {
            "plan": "pro",
            "city": "Cotonou",
        },
    },
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
        'Content-Type: application/json',
        'Idempotency-Key: ' . bin2hex(random_bytes(16)),
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'first_name' => 'Awa',
        'email' => 'awa@exemple.com',
        'phone_number' => '+22997000000',
        'country_code' => 'BJ',
        'preferred_channel' => 'whatsapp',
        'traits' => [
            'plan' => 'pro',
            'city' => 'Cotonou',
        ],
    ]),
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 201
{
  "object": "lead",
  "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
  "first_name": "Awa",
  "email": "awa@exemple.com",
  "phone_number": "+22997000000",
  "country_code": "BJ",
  "preferred_channel": "whatsapp",
  "status": "cold",
  "funnel_id": "3c59dc04-8f1e-4b6a-9d2c-1e5f7a9b0c21",
  "traits": {
    "plan": "pro",
    "city": "Cotonou"
  },
  "unsubscribed": false,
  "unsubscribed_at": null,
  "created_at": "2026-10-14T09:12:31.000Z",
  "updated_at": "2026-10-15T16:02:11.000Z",
  "created": true
}

Erreurs spécifiques

422 Paramètre invalide (invalid_request) ; param indique le champ en cause.
403 Quota mensuel de leads atteint (quota_exceeded) ou canal non inclus dans votre offre (permission_error).
404 Tunnel (funnel_id) introuvable, ou appartenant à un autre compte (not_found).
409 Idempotency-Key réutilisée avec un autre corps (idempotency_key_reused) ou requête identique encore en cours (idempotency_request_in_progress).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Équivalent pour les agents IA : l'outil MCP upsert_lead.

Modifier un lead

PATCH /api/platform/v1/leads/:id leads:write

Modifie uniquement les champs envoyés. traits est fusionné au premier niveau : une clé envoyée remplace la valeur existante (y compris par null), les autres clés sont conservées. Un lead doit garder au moins un email ou un téléphone. Émet lead.updated, et lead.converted au passage à converted.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du lead.

Corps de la requête (JSON)

Champ Type Description
first_name string Prénom.
email string | null Email.
phone_number string | null Téléphone, format international.
country_code string Code ISO à 2 lettres.
preferred_channel string whatsapp, email ou sms.
status string cold, warm, converted ou blacklisted. Passer à converted émet lead.converted.
traits object Fusion superficielle avec les traits existants.

Exemple de requête

curl -X PATCH 'https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80' \
  -H "Authorization: Bearer $STRIKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "converted",
    "traits": {
      "last_order": "CMD-1042"
    }
  }'
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "status": "converted",
    "traits": {
      "last_order": "CMD-1042"
    }
  }),
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.patch(
    "https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    json={
        "status": "converted",
        "traits": {
            "last_order": "CMD-1042",
        },
    },
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'status' => 'converted',
        'traits' => [
            'last_order' => 'CMD-1042',
        ],
    ]),
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "lead",
  "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
  "first_name": "Awa",
  "email": "awa@exemple.com",
  "phone_number": "+22997000000",
  "country_code": "BJ",
  "preferred_channel": "whatsapp",
  "status": "converted",
  "funnel_id": "3c59dc04-8f1e-4b6a-9d2c-1e5f7a9b0c21",
  "traits": {
    "plan": "pro",
    "city": "Cotonou",
    "last_order": "CMD-1042"
  },
  "unsubscribed": false,
  "unsubscribed_at": null,
  "created_at": "2026-10-14T09:12:31.000Z",
  "updated_at": "2026-10-15T16:02:11.000Z"
}

Erreurs spécifiques

404 Lead introuvable, ou appartenant à un autre compte (not_found).
422 Paramètre invalide (invalid_request) ; param indique le champ en cause.
409 Email ou téléphone déjà utilisé par un autre lead (conflict).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Équivalent pour les agents IA : l'outil MCP update_lead.

Supprimer un lead (RGPD)

DELETE /api/platform/v1/leads/:id leads:write

Efface définitivement le lead et ses données personnelles (droit à l’effacement). Ses inscriptions en cours sont arrêtées. Cette action est irréversible et émet lead.deleted.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du lead.

Exemple de requête

curl -X DELETE 'https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
if (!response.ok) throw new Error((await response.json()).error.message)
import os
import requests

response = requests.delete(
    "https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    timeout=10,
)
response.raise_for_status()
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "lead",
  "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
  "deleted": true
}

Erreurs spécifiques

404 Lead introuvable, ou appartenant à un autre compte (not_found).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Événements d’un lead

GET /api/platform/v1/leads/:id/events events:read

Historique des événements de tracking rattachés au lead, du plus récent au plus ancien.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du lead.

Paramètres de requête

Champ Type Description
name string Filtre sur le nom de l’événement.
since datetime Survenus à partir de cette date (ISO 8601).
limit integer Nombre d’éléments par page, de 1 à 100. Par défaut 25.
cursor string Valeur next_cursor de la page précédente. Voir Pagination.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80/events?limit=20' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80/events?limit=20', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80/events",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    params={
        "limit": 20,
    },
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/leads/8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80/events?limit=20');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "list",
  "data": [
    {
      "object": "event",
      "id": "418230",
      "name": "checkout_started",
      "lead_id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
      "anonymous_id": "a1b2c3d4",
      "properties": {
        "cart_total": 25000,
        "currency": "XOF"
      },
      "message_id": "b7c9e1f2-3a4d-4e5f-8a9b-0c1d2e3f4a5b",
      "timestamp": "2026-10-15T15:58:02.000Z",
      "received_at": "2026-10-15T15:58:03.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Erreurs spécifiques

404 Lead introuvable, ou appartenant à un autre compte (not_found).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Une question sur l'intégration ? Écrivez à contact@strike.app en indiquant l'endpoint, l'heure et le request_id de la réponse.