Aller au contenu
WbizTool

API des rappels

API d'annulation de rappels

Arrêtez un rappel récurrent pour qu'il ne s'exécute plus jamais. Utilisez-la lorsqu'un client paie, qu'un abonnement se termine ou qu'une automatisation n'est plus nécessaire.

POSThttps://wbiztool.com/api/v1/reminder/cancel/

Corps: JSON ou champs de formulaire

Vous avez besoin du reminder_id renvoyé par Créer un rappel. Si vous ne l'avez pas, retrouvez-le avec Lister les rappels.

Exemple rapide#

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "reminder_id": "3187"
  }'

Remplacez 12345 et YOUR_API_KEY par vos propres valeurs. Consultez Authentification pour savoir où les trouver.

Paramètres de la requête#

client_idintegerobligatoire

Votre ID client API, dans Paramètres → Clés API.

api_keystringobligatoire

Votre clé API, sur cette même page.

reminder_idstringobligatoire

ID du rappel à annuler, tel que renvoyé par Créer un rappel ou Lister les rappels. Il doit appartenir au même espace de travail que la clé API.

Vous pouvez aussi envoyer des champs de formulaire au lieu de JSON :

curl -X POST https://wbiztool.com/api/v1/reminder/cancel/ \
  -d client_id=12345 \
  -d api_key=YOUR_API_KEY \
  -d reminder_id=3187

Réponse#

Une requête réussie renvoie le code HTTP 200 :

{
  "message": "Reminder cancelled successfully",
  "status": 1
}
ChampTypeDescription
statusinteger1 si le rappel a été annulé, 0 si la requête a échoué.
messagestringReminder cancelled successfully, sinon l'erreur.

Erreurs#

Les erreurs renvoient le code HTTP 400 avec status à 0, sauf indication contraire :

{ "status": 0, "message": "Reminder not found" }
MessageComment corriger
Invalid JSON format: …Le corps JSON n'est pas valide. Vous obtenez aussi ce message pour une requête de formulaire sans client_id, ou pour toute requête GET.
Reminder ID cannot be nullAjoutez reminder_id.
Auth Error - Please send correct API key and Client idEnvoyez à la fois client_id et api_key.
Invalid client idEnvoyez client_id sous forme de nombre.
Invalid reminder idreminder_id doit être un nombre entier, comme 3187.
Auth Error: invalid api keyLa clé n'existe pas, a été supprimée ou appartient à un autre client_id. Testez-la avec Vérifier les identifiants.
Auth Error: please check client idLa clé n'est liée à aucun espace de travail. Créez une nouvelle clé dans l'espace de travail que vous souhaitez utiliser.
Demo Account cannot access APIsUtilisez un compte standard.
Upgrade your plan to use reminders featureVotre forfait n'inclut pas les rappels. Les rappels créés auparavant continuent de s'exécuter et d'envoyer des messages, et ils ne peuvent être ni annulés ni mis en pause, que ce soit via l'API ou le tableau de bord, tant que vous ne passez pas à un forfait supérieur.
Reminder not found (HTTP 404)L'ID n'existe pas, appartient à un autre espace de travail, ou le rappel a déjà été annulé.
Error cancelling reminder: … (HTTP 500)Un problème est survenu de notre côté. Réessayez.

Effets de l'annulation#

  • Le rappel s'arrête immédiatement et ne s'exécutera plus. Les rappels en pause peuvent aussi être annulés.
  • Il disparaît de Lister les rappels et de la page Rappels.
  • Un rappel annulé ne peut pas être restauré. Pour recommencer, créez un nouveau rappel.
  • Un message que le rappel avait déjà mis en file d'attente avant l'annulation n'est pas supprimé et peut encore être envoyé.

Conseils#

  • Annuler deux fois renvoie Reminder not found. Si vous réessayez des requêtes, interprétez ce message comme « déjà annulé ».
  • La mise en pause n'est pas disponible via l'API. Pour arrêter temporairement un rappel, mettez-le plutôt en pause sur la page Rappels.
  • Modifier une planification : il n'existe pas d'API de mise à jour. Annulez le rappel et créez-en un nouveau avec la nouvelle cron_expression.