Skip to Content
Référence de l'APIListe d'attente

Liste d’attente

Gérez la liste d’attente de votre projet avant le lancement. Nécessite que la fonctionnalité de liste d’attente soit activée pour le projet.

GET/v1/waitlist/signups

ParameterTypeDescription
searchstringFiltrer par sous-chaîne d'e-mail.
statusstringFiltrer par statut : waiting, invited ou joined.
limitintegerTaille de page. 25 par défaut.
offsetintegerNombre d'éléments à ignorer. 0 par défaut.

POST/v1/waitlist/signups

ParameterTypeDescription
emailrequiredstringE-mail de la personne qui s'inscrit.
referral_codestringCode de parrainage issu du lien de partage d'une autre inscription (`?ref=`).

GET/v1/waitlist/signups/:id

PATCH/v1/waitlist/signups/:id

ParameterTypeDescription
statusrequiredstringNouveau statut : waiting, invited ou joined. invited horodate invited_at ; joined horodate joined_at.

DELETE/v1/waitlist/signups/:id

Créer une inscription nécessite un accès en écriture d’un forfait payant. L’API n’envoie aucun e-mail — utilisez le token renvoyé pour construire le lien de statut du portail (/waitlist/status?token=...) et referral_code pour le lien de partage.

Lister les inscriptions

curl "https://api.supdesk.app/v1/waitlist/signups?status=waiting&limit=10" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } ], "pagination": { "limit": 25, "offset": 0, "has_more": false } }

Les positions sont calculées en direct sur les inscriptions en attente ; les inscriptions invited et joined ont une position null.

Créer une inscription

curl -X POST https://api.supdesk.app/v1/waitlist/signups \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "email": "jamie@example.com" }'
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 0, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } }

Récupérer une inscription

curl "https://api.supdesk.app/v1/waitlist/signups/8f7a..." \ -H "Authorization: Bearer sd_live_..."
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } }

Renvoie une seule inscription, ou 404 si l’id est inconnu.

Mettre à jour une inscription

curl -X PATCH https://api.supdesk.app/v1/waitlist/signups/8f7a... \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "status": "invited" }'
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "invited", "position": null, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": "2026-07-02T10:00:00Z", "joined_at": null } }

Seul status peut être modifié. Passer à invited horodate invited_at ; passer à joined horodate joined_at. Nécessite un accès en écriture d’un forfait payant.

Supprimer une inscription

curl -X DELETE https://api.supdesk.app/v1/waitlist/signups/8f7a... \ -H "Authorization: Bearer sd_live_..."

Supprime définitivement l’inscription et renvoie 204. Le même e-mail peut se réinscrire.

Last updated on