Aller au contenu

Suivre les invitations

Lister les invitations envoyées ou celles d'un client, relancer une invitation expirée et annuler une invitation en attente.

GuideAdministrateurDéveloppeur
Accès requis
Droits invitations.read, invitations.create (relance) et invitations.revoke (annulation)
Durée
5 min
Voir en Markdown

Après l'envoi, suivez vos invitations : qui a accepté, lesquelles ont expiré, lesquelles relancer. Ces opérations passent par l'API publique.

Avant de commencer

  • Vous appelez l'API avec une clé API ou le jeton d'un administrateur, avec le droit invitations.read. Pour relancer, il faut aussi invitations.create ; pour annuler, invitations.revoke.
  • Relancer ou annuler une invitation est réservé à son auteur et aux administrateurs du client, du réseau ou du propriétaire concernés.

Lister les invitations

GET/api/invitations/by-customer/{customerId}
GET/api/invitations/sent

/by-customer/{customerId} liste les invitations d'un client (UUID ou WID du client). /sent liste les invitations que vous avez envoyées. Les deux acceptent page, limit et status (par exemple PENDING).

Bash
curl "https://api.wakastart.app/api/invitations/by-customer/Cu9pL2?status=PENDING&page=1&limit=20" \
  -H "x-api-key: sk_test_exemple"
TypeScript
const response = await fetch(
  "https://api.wakastart.app/api/invitations/by-customer/Cu9pL2?status=PENDING&page=1&limit=20",
  { headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
);
const invitations = await response.json();

Réponse attendue (extrait) :

JSON
{
  "data": [
    {
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "invitedEmail": "marie.dupont@cabinet-exemple.fr",
      "status": "PENDING",
      "envType": "prod",
      "expiresAt": "2026-11-02T09:30:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}

Une invitation en attente dont l'échéance est passée apparaît encore en PENDING tant que personne ne l'a présentée : comparez expiresAt à la date du jour.

Relancer une invitation

POST/api/invitations/{id}/resend

La relance génère un nouveau jeton, repousse l'échéance et renvoie l'e-mail. Elle s'applique à une invitation en attente, expirée ou annulée ; une invitation acceptée renvoie une erreur 400.

Bash
curl -X POST "https://api.wakastart.app/api/invitations/1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/resend" \
  -H "x-api-key: sk_test_exemple"
TypeScript
await fetch(
  "https://api.wakastart.app/api/invitations/1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/resend",
  { method: "POST", headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
);

Réponse attendue : l'invitation, au statut PENDING, avec une nouvelle valeur de expiresAt. Si l'e-mail ne peut pas partir, l'invitation retrouve son état précédent.

Important

Après une relance, l'ancien lien ne fonctionne plus. Prévenez la personne qu'elle doit utiliser le dernier e-mail reçu.

Annuler une invitation

DELETE/api/invitations/{id}

L'invitation passe au statut CANCELLED et son lien cesse de fonctionner. Une invitation acceptée ne s'annule pas : désactivez plutôt l'utilisateur (voir Gérer un utilisateur).

Bash
curl -X DELETE "https://api.wakastart.app/api/invitations/1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" \
  -H "x-api-key: sk_test_exemple"

Réponse attendue : l'invitation au statut CANCELLED.

Vérifier le résultat

Rappelez GET /api/invitations/by-customer/Cu9pL2 : l'invitation relancée est en PENDING avec sa nouvelle échéance, l'invitation annulée en CANCELLED.

Voir aussi